From 83ac823aa902826915baef2ea302033e284d6213 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Thu, 26 Mar 2026 13:49:03 -0400 Subject: [PATCH 01/11] docs: scaffold Docusaurus site with test fixtures and API metadata extraction - Scaffold Docusaurus 3.x with TypeScript in website/ - Strip blog, configure for Kubernetes JS client project - Add tsconfig.docs.json excluding src/gen/** and src/api.ts - Create transform script test fixtures with edge cases - Add API group extraction script from swagger.json (65 APIs mapped) Wave 1 complete (Tasks 1-4) --- website/.gitignore | 20 + website/README.md | 41 + website/docs/intro.md | 47 + website/docs/tutorial-basics/_category_.json | 8 + .../docs/tutorial-basics/congratulations.md | 23 + .../tutorial-basics/create-a-blog-post.md | 34 + .../docs/tutorial-basics/create-a-document.md | 57 + website/docs/tutorial-basics/create-a-page.md | 43 + .../docs/tutorial-basics/deploy-your-site.md | 31 + .../tutorial-basics/markdown-features.mdx | 152 + website/docs/tutorial-extras/_category_.json | 7 + .../img/docsVersionDropdown.png | Bin 0 -> 25427 bytes .../tutorial-extras/img/localeDropdown.png | Bin 0 -> 27841 bytes .../tutorial-extras/manage-docs-versions.md | 55 + .../tutorial-extras/translate-your-site.md | 88 + website/docusaurus.config.ts | 123 + website/package-lock.json | 18448 ++++++++++++++++ website/package.json | 47 + .../fixtures/fixture-expected-issues.md | 107 + .../fixtures/fixture-expected-small.md | 58 + .../__tests__/fixtures/fixture-small.md | 57 + .../__tests__/fixtures/fixture-with-issues.md | 102 + website/scripts/__tests__/transform.test.mjs | 141 + website/scripts/api-group-map.json | 327 + website/scripts/extract-api-groups.mjs | 174 + website/sidebars.ts | 33 + .../src/components/HomepageFeatures/index.tsx | 71 + .../HomepageFeatures/styles.module.css | 11 + website/src/css/custom.css | 62 + website/src/pages/index.module.css | 23 + website/src/pages/index.tsx | 44 + website/src/pages/markdown-page.md | 7 + website/static/.nojekyll | 0 website/static/img/docusaurus-social-card.jpg | Bin 0 -> 55746 bytes website/static/img/docusaurus.png | Bin 0 -> 5142 bytes website/static/img/favicon.ico | Bin 0 -> 3626 bytes website/static/img/logo.svg | 1 + .../static/img/undraw_docusaurus_mountain.svg | 171 + .../static/img/undraw_docusaurus_react.svg | 170 + website/static/img/undraw_docusaurus_tree.svg | 40 + website/tsconfig.docs.json | 15 + website/tsconfig.json | 8 + 42 files changed, 20846 insertions(+) create mode 100644 website/.gitignore create mode 100644 website/README.md create mode 100644 website/docs/intro.md create mode 100644 website/docs/tutorial-basics/_category_.json create mode 100644 website/docs/tutorial-basics/congratulations.md create mode 100644 website/docs/tutorial-basics/create-a-blog-post.md create mode 100644 website/docs/tutorial-basics/create-a-document.md create mode 100644 website/docs/tutorial-basics/create-a-page.md create mode 100644 website/docs/tutorial-basics/deploy-your-site.md create mode 100644 website/docs/tutorial-basics/markdown-features.mdx create mode 100644 website/docs/tutorial-extras/_category_.json create mode 100644 website/docs/tutorial-extras/img/docsVersionDropdown.png create mode 100644 website/docs/tutorial-extras/img/localeDropdown.png create mode 100644 website/docs/tutorial-extras/manage-docs-versions.md create mode 100644 website/docs/tutorial-extras/translate-your-site.md create mode 100644 website/docusaurus.config.ts create mode 100644 website/package-lock.json create mode 100644 website/package.json create mode 100644 website/scripts/__tests__/fixtures/fixture-expected-issues.md create mode 100644 website/scripts/__tests__/fixtures/fixture-expected-small.md create mode 100644 website/scripts/__tests__/fixtures/fixture-small.md create mode 100644 website/scripts/__tests__/fixtures/fixture-with-issues.md create mode 100644 website/scripts/__tests__/transform.test.mjs create mode 100644 website/scripts/api-group-map.json create mode 100755 website/scripts/extract-api-groups.mjs create mode 100644 website/sidebars.ts create mode 100644 website/src/components/HomepageFeatures/index.tsx create mode 100644 website/src/components/HomepageFeatures/styles.module.css create mode 100644 website/src/css/custom.css create mode 100644 website/src/pages/index.module.css create mode 100644 website/src/pages/index.tsx create mode 100644 website/src/pages/markdown-page.md create mode 100644 website/static/.nojekyll create mode 100644 website/static/img/docusaurus-social-card.jpg create mode 100644 website/static/img/docusaurus.png create mode 100644 website/static/img/favicon.ico create mode 100644 website/static/img/logo.svg create mode 100644 website/static/img/undraw_docusaurus_mountain.svg create mode 100644 website/static/img/undraw_docusaurus_react.svg create mode 100644 website/static/img/undraw_docusaurus_tree.svg create mode 100644 website/tsconfig.docs.json create mode 100644 website/tsconfig.json diff --git a/website/.gitignore b/website/.gitignore new file mode 100644 index 00000000000..b2d6de30624 --- /dev/null +++ b/website/.gitignore @@ -0,0 +1,20 @@ +# Dependencies +/node_modules + +# Production +/build + +# Generated files +.docusaurus +.cache-loader + +# Misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/website/README.md b/website/README.md new file mode 100644 index 00000000000..b28211a9bbd --- /dev/null +++ b/website/README.md @@ -0,0 +1,41 @@ +# Website + +This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. + +## Installation + +```bash +yarn +``` + +## Local Development + +```bash +yarn start +``` + +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. + +## Build + +```bash +yarn build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + +## Deployment + +Using SSH: + +```bash +USE_SSH=true yarn deploy +``` + +Not using SSH: + +```bash +GIT_USER= yarn deploy +``` + +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/website/docs/intro.md b/website/docs/intro.md new file mode 100644 index 00000000000..88f95714453 --- /dev/null +++ b/website/docs/intro.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- + +# Tutorial Intro + +Let's discover **Docusaurus in less than 5 minutes**. + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 20.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/website/docs/tutorial-basics/_category_.json b/website/docs/tutorial-basics/_category_.json new file mode 100644 index 00000000000..2e6db55b1eb --- /dev/null +++ b/website/docs/tutorial-basics/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Tutorial - Basics", + "position": 2, + "link": { + "type": "generated-index", + "description": "5 minutes to learn the most important Docusaurus concepts." + } +} diff --git a/website/docs/tutorial-basics/congratulations.md b/website/docs/tutorial-basics/congratulations.md new file mode 100644 index 00000000000..04771a00b72 --- /dev/null +++ b/website/docs/tutorial-basics/congratulations.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 6 +--- + +# Congratulations! + +You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. + +Docusaurus has **much more to offer**! + +Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. + +Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) + +## What's next? + +- Read the [official documentation](https://docusaurus.io/) +- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) +- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) +- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) +- Add a [search bar](https://docusaurus.io/docs/search) +- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) +- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/website/docs/tutorial-basics/create-a-blog-post.md b/website/docs/tutorial-basics/create-a-blog-post.md new file mode 100644 index 00000000000..550ae17ee1a --- /dev/null +++ b/website/docs/tutorial-basics/create-a-blog-post.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 3 +--- + +# Create a Blog Post + +Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... + +## Create your first Post + +Create a file at `blog/2021-02-28-greetings.md`: + +```md title="blog/2021-02-28-greetings.md" +--- +slug: greetings +title: Greetings! +authors: + - name: Joel Marcey + title: Co-creator of Docusaurus 1 + url: https://github.com/JoelMarcey + image_url: https://github.com/JoelMarcey.png + - name: Sébastien Lorber + title: Docusaurus maintainer + url: https://sebastienlorber.com + image_url: https://github.com/slorber.png +tags: [greetings] +--- + +Congratulations, you have made your first post! + +Feel free to play around and edit this post as much as you like. +``` + +A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/website/docs/tutorial-basics/create-a-document.md b/website/docs/tutorial-basics/create-a-document.md new file mode 100644 index 00000000000..c22fe294468 --- /dev/null +++ b/website/docs/tutorial-basics/create-a-document.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 2 +--- + +# Create a Document + +Documents are **groups of pages** connected through: + +- a **sidebar** +- **previous/next navigation** +- **versioning** + +## Create your first Doc + +Create a Markdown file at `docs/hello.md`: + +```md title="docs/hello.md" +# Hello + +This is my **first Docusaurus document**! +``` + +A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). + +## Configure the Sidebar + +Docusaurus automatically **creates a sidebar** from the `docs` folder. + +Add metadata to customize the sidebar label and position: + +```md title="docs/hello.md" {1-4} +--- +sidebar_label: 'Hi!' +sidebar_position: 3 +--- + +# Hello + +This is my **first Docusaurus document**! +``` + +It is also possible to create your sidebar explicitly in `sidebars.js`: + +```js title="sidebars.js" +export default { + tutorialSidebar: [ + 'intro', + // highlight-next-line + 'hello', + { + type: 'category', + label: 'Tutorial', + items: ['tutorial-basics/create-a-document'], + }, + ], +}; +``` diff --git a/website/docs/tutorial-basics/create-a-page.md b/website/docs/tutorial-basics/create-a-page.md new file mode 100644 index 00000000000..20e2ac30055 --- /dev/null +++ b/website/docs/tutorial-basics/create-a-page.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 1 +--- + +# Create a Page + +Add **Markdown or React** files to `src/pages` to create a **standalone page**: + +- `src/pages/index.js` → `localhost:3000/` +- `src/pages/foo.md` → `localhost:3000/foo` +- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` + +## Create your first React Page + +Create a file at `src/pages/my-react-page.js`: + +```jsx title="src/pages/my-react-page.js" +import React from 'react'; +import Layout from '@theme/Layout'; + +export default function MyReactPage() { + return ( + +

My React page

+

This is a React page

+ + ); +} +``` + +A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). + +## Create your first Markdown Page + +Create a file at `src/pages/my-markdown-page.md`: + +```mdx title="src/pages/my-markdown-page.md" +# My Markdown page + +This is a Markdown page +``` + +A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/website/docs/tutorial-basics/deploy-your-site.md b/website/docs/tutorial-basics/deploy-your-site.md new file mode 100644 index 00000000000..1c50ee063ef --- /dev/null +++ b/website/docs/tutorial-basics/deploy-your-site.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 5 +--- + +# Deploy your site + +Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). + +It builds your site as simple **static HTML, JavaScript and CSS files**. + +## Build your site + +Build your site **for production**: + +```bash +npm run build +``` + +The static files are generated in the `build` folder. + +## Deploy your site + +Test your production build locally: + +```bash +npm run serve +``` + +The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). + +You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/website/docs/tutorial-basics/markdown-features.mdx b/website/docs/tutorial-basics/markdown-features.mdx new file mode 100644 index 00000000000..35e00825ed7 --- /dev/null +++ b/website/docs/tutorial-basics/markdown-features.mdx @@ -0,0 +1,152 @@ +--- +sidebar_position: 4 +--- + +# Markdown Features + +Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. + +## Front Matter + +Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): + +```text title="my-doc.md" +// highlight-start +--- +id: my-doc-id +title: My document title +description: My document description +slug: /my-custom-url +--- +// highlight-end + +## Markdown heading + +Markdown text with [links](./hello.md) +``` + +## Links + +Regular Markdown links are supported, using url paths or relative file paths. + +```md +Let's see how to [Create a page](/create-a-page). +``` + +```md +Let's see how to [Create a page](./create-a-page.md). +``` + +**Result:** Let's see how to [Create a page](./create-a-page.md). + +## Images + +Regular Markdown images are supported. + +You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): + +```md +![Docusaurus logo](/img/docusaurus.png) +``` + +![Docusaurus logo](/img/docusaurus.png) + +You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: + +```md +![Docusaurus logo](./img/docusaurus.png) +``` + +## Code Blocks + +Markdown code blocks are supported with Syntax highlighting. + +````md +```jsx title="src/components/HelloDocusaurus.js" +function HelloDocusaurus() { + return

Hello, Docusaurus!

; +} +``` +```` + +```jsx title="src/components/HelloDocusaurus.js" +function HelloDocusaurus() { + return

Hello, Docusaurus!

; +} +``` + +## Admonitions + +Docusaurus has a special syntax to create admonitions and callouts: + +```md +:::tip My tip + +Use this awesome feature option + +::: + +:::danger Take care + +This action is dangerous + +::: +``` + +:::tip My tip + +Use this awesome feature option + +::: + +:::danger Take care + +This action is dangerous + +::: + +## MDX and React Components + +[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: + +```jsx +export const Highlight = ({children, color}) => ( + { + alert(`You clicked the color ${color} with label ${children}`) + }}> + {children} + +); + +This is Docusaurus green ! + +This is Facebook blue ! +``` + +export const Highlight = ({children, color}) => ( + { + alert(`You clicked the color ${color} with label ${children}`); + }}> + {children} + +); + +This is Docusaurus green ! + +This is Facebook blue ! diff --git a/website/docs/tutorial-extras/_category_.json b/website/docs/tutorial-extras/_category_.json new file mode 100644 index 00000000000..a8ffcc19300 --- /dev/null +++ b/website/docs/tutorial-extras/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Tutorial - Extras", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/website/docs/tutorial-extras/img/docsVersionDropdown.png b/website/docs/tutorial-extras/img/docsVersionDropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..97e4164618b5f8beda34cfa699720aba0ad2e342 GIT binary patch literal 25427 zcmXte1yoes_ckHYAgy#tNK1DKBBcTn3PU5^T}n!qfaD-4ozfv4LwDEEJq$50_3{4x z>pN@insx5o``P<>PR`sD{a#y*n1Gf50|SFt{jJJJ3=B;7$BQ2i`|(aulU?)U*ArVs zEkz8BxRInHAp)8nI>5=Qj|{SgKRHpY8Ry*F2n1^VBGL?Y2BGzx`!tfBuaC=?of zbp?T3T_F&N$J!O-3J!-uAdp9^hx>=e$CsB7C=`18SZ;0}9^jW37uVO<=jZ2lcXu$@ zJsO3CUO~?u%jxN3Xeb0~W^VNu>-zc%jYJ_3NaW)Og*rVsy}P|ZAyHRQ=>7dY5`lPt zBOb#d9uO!r^6>ERF~*}E?CuV73AuO-adQoSc(}f~eKdXqKq64r*Ec7}r}qyJ7w4C& zYnwMWH~06jqoX6}6$F7oAQAA>v$K`84HOb_2fMqxfLvZ)Jm!ypKhlC99vsjyFhih^ zw5~26sa{^4o}S)ZUq8CfFD$QZY~RD-k7(-~+Y5^;Xe9d4YHDVFW_Dp}dhY!E;t~Sc z-`_twJHLiPPmYftdEeaJot~XuLN5Ok;SP3xcYk(%{;1g9?cL4o&HBdH!NCE4sP5eS z5)5{?w7d>Sz@gXBqvPX;d)V3e*~!Vt`NbpN`QF~%>G8?k?d{p=+05MH^2++^>gL7y z`OWR^!qO_h+;V4U=ltx9H&l0NdF}M{WO-%d{NfymLh?uGFRreeSy+L=;K`|3Bnl0M zUM>D-bGEXv<>loyv#@k=dAYW}1%W`P<`!PiGcK&G-`-w7>aw=6xwN*)z{qlNbg;3t z^O)Pi!#xywEfk@@yuK+QDEwCaUH{;SoPy%*&Fy2_>@T??kjrXND+-B>Ysz{4{Q2bO zytdB!)SqeR7Z*b#V`wz;Q9sbwBsm#*a%;Z0xa6Pm3dtYF3Ne7}oV>>#H$FLyfFpTc z@fjI^X>4kV`VsTHpy&bqaD992>*x36$&m_u8MOgAKnr zix1C^4Kv*>^8IV-8_jZkZSn%yscddBFqkpaRTTAnS5A$!9KdgBseck^JSIQS`wRWHIZ&85f`i++% z68t8XiOy$@M67#u+Xi6bxpuq+`HWa<2?N@OcnUhX?Fa0ucuMgFJFc-@1+=(NlQ>>F zRDxG-|GOh}P`zp=#(X0xY7b!pCjittaWhLjHXBB#-Po`?sO81ZebXXp;sg3B6U;yT z7ltQRr)1+s9JQ^V!592xtqynFYr$yy)8J4=_Fovpb*N%#EBk3~TNxng@wp@YN7Lqp zrjUU+o-9X*B{;#FfWF+8xsS-jI`K=*Kw`Xfb@RSO_U)QsNHa<|mWk9yQ?OwtR*_xq zmD=jg&|q#_bdPo=j-*xO@t@Lx#ApL+J`iqWlGkq6;4fv@4RCK_O9tc(xtrrh=-c5R z69GA#i8S&gK?|;>DM8&0G0qF?C*`-kOcVP3)1oi%f47pC4CS=HBdpf`E)$Hno3D*LM*Mxsl@|fX(Xf%aXWP!}X9^S#Vk`h=79=r%L^l^YWXw_fRl+4teQ3x9_*k%}TKmP12k&)U zMNC;?1$T%`tp^#EZUUbydm4SOs@A)}3PP>tiL3j_W06pb3vSHu)DJU-0m)ledRGV0 zJ|rcZ1U@_hCyPE6_-wiimvjR3t);y*Qdi`BKX*PP29RBAsD8W-^u0fLrRq zwCLWC=t#&Nb(JimFikS-+jq}=-klKJuPf|#4pY8f?a%e6U2$1>GPfs~QJLAlns4;O zgz6*qdCCdKNu92Gtjo^ob%T4S7Qi-4NMGg1!+m0yH08I3TITyT6-g}m=2u_lckZ^e zq;^$v+pjrNbh#BOPdii=sJ1bq8F?sZTJcTI5o-P0V#bJPYY`?awnv-41^CJh$BpLP z@aNtrc;&0^lO>O1M4Is=8YA9!yo9_AI^mA7`Aw!579-QByLL>P$1D=@r}QPn38D;% zpBWvkXSRS?b^4Pq$yjf%7Lcq#0#b>rLc!^-G|4-BD83fHp~~6CQ_U~u{@(n0go&P^ zDHT6>h=0KJ)xPF^Wh5@tUEbM@gb&7vU*9YcX;|;ESv3bj^6HmWbTMt;Zj&y(k;?)$ z!J2pIQeCULGqRb5%F}d?EV$v(x+Zqs7+Bj<=5FIW5H^? z1(+h@*b0z+BK^~jWy5DgMK&%&%93L?Zf|KQ%UaTMX@IwfuOw_Jnn?~71naulqtvrM zCrF)bGcGsZVHx6K%gUR%o`btyOIb@);w*? z0002^Q&|A-)1GGX(5lYp#|Rrzxbtv$Z=Yht;8I!nB~-^7QUe4_dcuTfjZzN&*WCjy z{r9Sr^dv=I%5Td#cFz>iZ_RSAK?IMTz<%#W)!YSnmft3Nlq~(I`{`Uk-Wm83Cik$W zA>ZEh#UqV*jtmtV`p(`VsJb>H>??z9lR#V(`9^UEGvTix4$!-_w1?L1)oZ^W!E0k* zCB7_q(G~1Q3x6mPdH1`hse+Jq;+?Cw?F&D*LQhHFoFJdd@$J@~sOg%)cymn7a4znI zCjvkBKBOSb2*i~|Qom$yT*r{rc!0nX+M`4zPT|h~`eXtS!4FPTH0(?%$=fr9Tr*nb z(TR6>{L$7k2WHlqIT4J->W-mYgM)ac(R(z56AY2Kiex&W>I$p+&x#bMNS&|p@eWOy zGD7es5=6U#uG^J26B@SERc=i`I+l4_*`E_OxW=&=4|rH=p;$GB!%As!i|~ypyq`M{ zX5L!TI*|QR-pt7Y$irT5b=w9KcWKG5oX;$>v|GNckJ5XfdZ#KHirMyigcqZ9UvabrO{ z8rDp1z0Fr%{{|@&ZFm^_46S#?HL)}=bp45eUvA1gf(mODfe+cGcF$6-ZaI;NvMu;v zcbHrkC+lE z7RwO#m?)*hw^|}s-z?wPDEMJ2%Ne3)j0Dnt?e(@i?bf<+s^BM?g^S5YKU~rg%aeTl zJf0#GyUY|~Y;9SV_?#uV9<{xsFjl^YeW{@1$61GkUgc9Xv6cL@uB^M?d@o7H zHKV^XV(Q|Q%Geas3dw$Jn&atPqxYB>>Ii<#Zv+@N8GYs#vrxfbS_%zJ#18<+55b3yBCV#A}|5J8EAtdUd zn{=~8r&YaM_GB^l@6D_xfSvmbrbJP^&RZ{np(I^~Osf9d>=xz;@EnY?(Egg`%_&Vt zJA2@>$gsV@XFKh@>0z#d4B>B{^W%bCgT;)f6R|f%yK=!bN2w`BOC_5VHz(Q+!7ID^ zl#oQ>nDe2!w&7tLJ8#8wzN%$7@_>{Hh2xdID<0$kb*>G$17$S3grFXLJQ>4!n!>-B zn>~N~Ri%vU@ccS?y8BTR)1#fe2q zlqzp;&z9I1lrZ*4NJn00*0|iPY)Z0d$3NTJ9HNQ+?JI;37?VSbqMkdoqyCsG=yp1B z-3WO8>t^=Fj^?PT?(-0dZ8y_FL2Z9`D!m-7Dgr7r>V~Rm8RQ@w>_PrbFo$N_#jGzx zKC&6u^^M`8cdv1&AJ-O}jSqCR94J?FnYw!JN3(k7cejfuS`7-j*t4GNaKH@|kkrB_uY?<%tF27r;kVj(nzxph1JsFr z#*%R0;+(NAevpx|F8|sz9}SI%^z@E#+KR{}h1fyNXo6z$e*+nNx|qKR4DoCl0?&Q@ zs8_MHOw&gA$VQz4yIo@Zg{!M@m9v_4{_V!x@I>5ZaG$rcOvUm9O0DW9tR>#oyg@l8O!7%+a(wcN zU}SdcI3?TjNeNXmMJ!GUx@tFbszrKU5?ewMLA zJ)^SSUMDXb)yO8<*A&?2bBN&NEk{+9q~*w%k^+OUs)b@Fs#!)#9E-|}*u zWAn}H61Uy!41$}d1d44D;guxTx^kD367XWM%5Dea)6$5&n;))D;D^r~G=m$CqS7L! zmLX|kejC<`PU-rS#;n2Y0*4;&?(ROps&9eVSDoY%G@-4kyG5AX|Fu&1M5Gm0(-Z6v%1@fS9$`LGCB zlH8i;1e!(dUd#1c@G(-^QedB)$yJ~Yke{h3 z$#|*Md8c7)??v!utM3QJT7mN@DE%_r@BYhvf))3qME|n>shVP(03fO0{Iye<3)wv9 zoYDZ$wDak&n*QW`-s6KKDk5X1OQ_ramOCv4gjh1}jy%9GX!s!hq`NW)&%o9y+YrmT z+u!YGVhHBA*{|c;^}Xg)elpF+dMcpHNALqheHQIX<8J#~;Ah^+Dw~L#CynKWfTWCu zCEbY3ybkQ225nUxd$i6(3SN^?}z{r>!_8$YiwX~LE`rzuT=q!8;h{UbMWDGL@VpWm; zZtr3$23sHj`&Co0No!R|5#Vt7{9}j|TwplkHdT=aUeQ*;9XQ2uW1WUTbA%kHwMR|UUq0xTEetKps9KmNYAS5aY+L31z8w-k=r7r5hSK=6A!^nU z8C>n~S?X}?D5`5c5&2wA0cxo;KgFAi4N2T%LF4fWoMQ=CTo>=1mjvBvW;|iPUB>xW z?K5>~6VIpJYo28I)EFl&7dAhqrB6A-(e-)leVf;X*$GA~eVokc6j+rvRq{{fZth{*dW0`N_!2w6Ll9fV z{aJuKFd-zavy0~QH9hD;H%Q(_Zn7nY>AkaeKuL7Q@G02wArkDPH53Qg5JGaH{_ehi z35yHf_=pB1wY&Ak3EZ-^Ml}MxJh6d_Z}jDN7RTDy68ton&H$4=>#b4w904+;t6CcZ zMtV{hLGR06a?g$sZA#7RlKPF4Bqk=}`#oc=#~O;oUX7hbb^NY3f2Nin?(&;E?zVkm zN}OTyV%mP6T5(MT-syZn(K?c9sk)z$K0AQvvk9#%4%)evu)aOXbB;x-*G5ljx|A;$ zZmCV}y(IS$SYPVS%g#3~I9lE#erA)7BgOkZC}~2)7B_BBStEVtr1+0nv{(A%zhmjT zsE;^zwY5(ZCyf%wwr*SJyK_?Gv_p!Oc-8$W?a03T_8q zb=XB6)**gF9AoG(=dN9-4yO7)FI}g2!0UFua`5ASTp*W2K#(fpZHPv2}6 zuI3YRPb*T9uhpKUc zPNT}NbGpABC}F~2UYA?vuN z*c2)mWKvZn<+PL%-Oq3lAhrw_j}+<$Tfvgoo)dRh((_MP7Iz=PwI|1>aObW5-b8qW zI@O0@c{EbVHN5a6k}i4y2?Jh~=Jd-MZnv)h^T1;2CAllrl%EHm`1{XUiW<7g+6{XS z&hVyh5*+TiVaO)+4PE3HcnsJajGx>gwo1EcWg^*Rn0l!#MVM%(Ywui_UjM8Dgspk@ z4`gne14lZ*`698%UOOx^(v_~kQiYj`WkY>(f5KDC5I{-Wi!KoINK)H^9m|SUliD=d zE;N>?`0x*{61(==UBrN}mpsdhOZ2N~I>oQ1avz|nvyfQQW_R6VAnn;IzqlxDB)0_Zw_Csf#5sdmb4LBwIyBk zv$NL*@acUJc4`FtA^-PzoHR zKXm{;9xP9kWW6MEPYuCeDqX@UiY(8GShF|L{-)R4_acdmp+&W~4nBxde z;pI70##wwE$hfIrpx@VQ`Yc>|xSP$S8~WoVKTg5Z*KMWE)Yp>$m>ZoNQ(u!z-#`mL z1jJZHKZ}Tc5Ap^(*KIg6ol~wx)s~So91kdWaF2c{?F58%EDiT9uV&xYWvS{aFS{hE zg--eu{(>bL!0h)=md^{aR(APus_Mr}+}|%Rb(>B&dHn3fw9>d3rkDH6x0-@)^Dkwj zjb75;-8>7gmW&$y_4x~rPX!&!>l3d<-kfo+g{PIl%s;UQ)Y+u z4&z}r;Sd{hco!{2a3}F*4CAcydj7`#V0_iRg%G&NxtQpm=(5VbGfiRW^NoBJ1rPE# zzYktZRk7>`{fdU((V`a+T{&n=cnr4LaS!S|hDOtXWb>_e-LwH+@FmdGw>6+B9J6~} zcBaNb(<-c6&|ghc-%o3xG(Op-q&pXd1CfV zgPNdKX~vGy-LS;4Q=161sLAoMaXGG7weBcT%KmWHZ${+6bC6yehCjqK36LdH>fR!{ z>Xe}eUaWsRp8U1&?E`K@0*oHDY-p{^+u0T&$b)J}|G6C(lSRuN&WgUd(rH=0h9hUz zj|U@1UmNWdbn)SLk^KR_nRxbB`hNKP>?@ocdEL;;1l||Q0{~Zx5N5FT_ z8{|xM9~@McIdv|?#WPK>1b&f`?=bvMO>?(;W^}|VZ|%*&C_rsnS5&E~%`>$1I#;~* zn=Wx?omuI3X^Q4D$;n_~HEv`6`Rwl7C)iTwB5O~BB+$PgQTGE~V(6h;78q+*a8tK* zi)1P_7BY;9ea2|o@l#u>z4b#X%;a|nTq^l*V({7P;k z=t-%I--DL{uv#dVtaWg|q`lNci7#N7sC(@vBesWbHEY@Gb4`DozcU20N<=vl;-%s5 z!WzFm74mydG1Hjwdk!c_6!|q+Noz5>DrCZ!jSQ+Yjti$3pBqeRl}Wv|eimpd!GOY~ zDw@@tGZHFbmVLNc^ilgjPQ1os7*AOkb2*LRb{O-+C97i_n z2I@>^O)#WwMhxr4s;^U&se%2V#g)$UMXcXHU)C<7ih`meC7t?9h6U9|gRL%vjBW=4 zyJ(KaCRlNg`fO6a(x7h==WMvQG|_Skr4D&0<8t`N`#*Y0lJn{f4xjR5Q%h*qiJ!9l z{{3xuZ%nm38N+XqLO_y}X{{=Z1sg+iy?Wk0(xmzIV8KVwj}M}&csjjc2tOdzyInRf zj&mB~+`^C>=hnyxW|Ah^U8Pcl0}jx|K^QWjuTpX%S?_Y({asp@tk2!qmNiJscA|3v`}jyo*ALZ(Rr*ar91T`}p~N<62j4RJ|PDBQI3t8Cdh) z?R$X25f31}sp@&0jG5+in zs$WmohuauhuK4uZ1iNJsy2T@EuDDT=`&$LT=jKS^o}44OK5cA$zAzZq&gS)a(=xC7 zC(q}(#ncl6@1^p;YG?lVnJ)t^7Ky53%ZtMKP6FKlx|zSaeDQD~}Xbf@cZU>-AI+P+4hN52dWFDA$qg=0!5}U9qLoblC z?2V$GDKb=Lv@me&d%DST)ouSOrEAoGtLxcGg1~Kmzbq?}YUf=NjR9D?F9<}N_ZiNa zZhdC>2_z-iy!(9g9{n11i3|~!hxmAYX6z9olmC=&YcsiKI;&XK#&iSd&6&{u1@Hd^ z&}sU>_G+y}Gi-8`-k*Exr{a$>MNGj_u%u$;s_fOjknwYR-qt1G|mi}nQ%CB|0Vp`=0tc2y(3 zJ}XmzSQQ~(SfJW-|mT1TaDmxNCml#nWVyhIvX z5(>8xARd*joOU-U;Dfj+E+nUJC25bpe>!0L^f@BXZEW73UVfjT$=FTfw8u@h@$hDQ zVua*ub@?Dlc%%H2Kt+bYLb>$(@roZ+vrM&so0RO(eTY12?=Hk4*qI39-0yU@%aQU) zh(=Pxi6yISqhKQ$i^SEeyiioo-1GNY25sM+qoj*Y3&qp^8_)87sMwbecGG~;>|9TP zREo(Axioj6Z+vp*b2~Yp&YghcPwB1H+J6C`1#2tPkLCkZ%eJSah9>34C6}Wx52PW# z^-a1fn~bY&PC$SE9!mvprG5JAMZ8#PQ1utYB%g4fm*YwmC=|j!Ynky<|7ZL;!BWr3 zFawY3dr};&T$Ip3YmV+)De<*8`l~v0VwiNIPNf3|&X$o&6@|n6LRM@CjYQR1 zWBH=K@#i3!;27}0=N!39tP9ZWSn8M>14nC%WHmBMuFJAk%Lb z3uC1S9h$5}_+BVizP47z7mQl9&0QY+JB+^dI{s zw`OaYK6by8i7`3&)Phx%c((j7B1YUWiF2MMqu4sv*rJ!i;BLj(fq}XbxPz*4fPY?O z@*Ky#cmpT^|NpZ9uUqz`68dgR9jtzXj=}e&QRIn}pQRT9PLxt|PUrc*i*0b!XrG!5 zn0}>27K&TEtQcrzD<@JD6Z~^YE+@bp^w7O54P0!hf0Y2>E)Q-^2GDnxCg+6##J=z7 z@ngMS&`rDgl6d+JcSuka%Z?(3I;F~=S0|1#j5>jeKEQlh=sBqfv!hBN|;yTWLomu=my`^LYikzJ(>0epsIY)kU18UXtB-3pcSlnHT_D|^@nAOvSZ&U8G z2j{}BU*x=`J<)n1d{C?*L9G7(UY zOa>7`PWnsf0_A36hyo=b^S{8-brz>TuX+X?u5rOaa-i+Qwt#GO{msTqNOcGW+e>Es zB9jlrN(d>)QU5{6)p@F-7=X4^mJ_o0PmD`XJxKX3yEPtUxGs`3c=nmm=R})T1N{pn z-4`5~hgSH{OLb&X7JJ{Kc!m~cw^Px|bf;E_^&_m2-RyF$>hpwb^&OK2x<&5mZY$DQ zM*Ba9X2yg~f2CrRi%7#Gmj8ToW&RX3woB;vaQS~RStNrN_ip=L(D5O`5ARa1*tbl$ zz*z9~cch#eZ(SfXecVU8>@a)YoW^a+0f3~j0Y?^-$NJeZx)){fSvT?~Oz zr|rs5)}M)5nL!oe|LIs_Tje3%Izv_8s~up;gZHa$tJ2apK4+*%@ezaqN}(Z)Knf?w z50}vMb<0<55q_7mTNOQDi&W|)caK!E^KS2+JE#Q+@^xmQv>inXC5o`mvE&$TOke$B zV8GSwhlTR2rzJ#_;)bk${WP%Ih)i=EYN8{o&z8%2I_q?VymrtR;v$zLkjrg{wpYbS zvAcy#5)@jAvZp4FuHHU2=>%7yAaF;Pr;R4Fs{JD~J3=fZ1&XUJg-%A~!KmHC3n)>YIEi}NEb z%--g1St?_*DOh+gnZHtmEkxs@isI}eRrc0wU8l;2b@mCiAM#Nn997Q+LV*)|qbtKQkb_f0o-p5pdd)@GMF*DshM3Aa+3F#`qRIwJ0hm)o|YEL#OaBEakx*CoYj z!aPt=uH3>5{Lo)X0vnhRQ)s3fJD8{|J(JOpEw+)Rk z`bt&Qmfn=@fB#v0H(jRr&%qMgqOh#^u@wR@511#rdFm|rRDW^uR0I;SFNFONvL|T< zNgTUA$F0a)aQgw8fuB6MGPB@qT?~BCYk5+Jsf=?}Mb;HKNTkLenT0K8t8|H}D?|hE zSgX!{rJBv{`q@9kgrWLKN$Lc=(eX|?lLDj zTIgDs2{@)$i(H$~)t&t0ljddg!CF6;h;#+vfsiOq1m6z-@3HjZf9Cwjssl8*? z-Zk;h*SQd?Jne_EnSeuFHFb<4o#^De>LcvXXN-SWl?t8{*wYg3myaD#!ASmyRX(M* zGTP9W!pDwsi#ZmX__)rLPoItw3NlJ2we~Weclgdr7?3%+JE=SOCt;iGP}}vJ5Q|LG zVyV6tvP?5JtW=tF&6vZPw&HPWnzz1x|7JWQiR85>W`0|GOLyooBAJSsXr;fTClQ*2 zaK)sev-vb*PP9gBV5`_Qo%^@(nz4=7wneRMzW!+lzgV`U{S>?Un=WkYC)GrP*^Co~ z39gtoderj4l0kRRPB`Ahk_XC*5YRAEO&?q0Mzru!IeuE^lBSp;^j8_6-!y50K|n_p zGMdRWFh-Fi>Ry&?gYb(4RdA{FOqob;0q^4FiX*<}mB;zWot5?G&X7RqtC)_A4|jTu z$#`}>b~R$z#yqsMjRktG(!I2WS~hnaPgt1B%D#`8tL9}l{0BaIb*@{Pzt#{=K}Oe* zDAsQ#vX=-a{P_Eyl10+;FIVppTs>K45GY321_I8QO(l>aZ1$65njm1IL>Tmd^bv>K zqvaOE2UgLp-Yu%rF$JfIMhMuRr(^h3Hp`{LBoH54u5@YGjy6Wg?Q*O?XEIX6kMCO~ z<_kZcb1u98AU{a8r7g=xIgs_PH3)hJ5I+6utGV-%RP@*Qi)z02$Wuo9%2dn$3FhdS z;i52o@P_mdzh~c5s^ah~8Ps7Wp+76`e#%y5agtQuPd3{4@zh;+PJ;Ul(o51qE_WV^ zg+~a_eJ|*Xi=4jabrA&e^&&@I6=VSbgQoPeA2W5wnF#LY-O>}Ljj#`MCRMaV%vO{76cz-Og(S_6~uR>qnR(*x+nLISCR#;o3%W_6?D!w;_CpEp6{@(I+A~0_7 zs}lPdr=NoC&$L2h;r!KHMBq)8eU7#yV&?{?? z=4x^BMDRXs3k2G`S|TGIzZ0Hg;o-%T^9GFBO*20Lb>W?krt$`*_Y)pIqLTXjE~di< ziI$JBW{M?JgMOp7XK0RqD!` zyjnzWp^?d+&R3;V!S}YBsE3^$ov%4ipg*$x>0&cLpey(^IE*D!A^->G&P+M7+J2(; zwd>Ep{Zo-~HYh#S%R%s38W8{Ca=WoD??Y3{$m(9%xV*`*LEmoP1$uIW>TgrB$+onv z_ndvbMOIqVFhw~TrM%u2A6A4v!m5V5;SK21dr|_++u|ReV)&#sK6$=&(H*ZZXM7U< z=e@Z}9GCKoq)cAQ9euu8+|}amPkIa3BNZHT6d18a1P&$d5_02Ht2I0xoGDxi-;5;j0tI=XFRNl62_x%#|RTOCW zg*`>@ux)y<;|r##9cIl^Q&4#~Z3CkHHz`X=;xCJy_@caXbk+{w{=u4_bgn+6>EKRa z8dA{~?4*L&vu;0?5LGS{cbn;+@q!-7usGB$?e_1K0#gE|Ot9ixD#X(4>uu)f#}~A3 z3@nGY`HD_hpAqWw8U%*?yVSuzvJm;5G+nq@Cd+=}W!n*06lvdQCuXal{9Xs<5I5oC zcw%nh=Wg?~Ugk@T1@^y}Np7w%vxB-A9tdKDt{<)FX^ubm$7SZacAr-%L-a1JwG)#C1c0gU_I^Cd_qciW@*(2ezbRpD6!<$ zQ+C*RGs|w;)ZO`^revsDl);H7f(3E%K@i2Y%eE!3cq&}mnmjtQ*Z=hEWe2W_A^XH?Nys^bJZp5h>K5an>5p6yjNY zREWvikLx;$(K_`V*R=<8<|J@62`31~=7iCV$p6c%Lg1YAc$h-uj ziA#pcUoF0HIj*$$+!IpLE!H*6%e?c8aHZ~W{8>f@QlFmqcJUBtER_3}jheE>hx}mv zf%%k^5;hsmrzrQC;sDn(d(nBjd1K!gR*&*-DQ4;zv;)vaatjg36nGZ?Rq_l;c6lQA zQhH0eWpKygvHd1%l_?G78|(|eJ53Tsg#N4Hvjo0QDebJQL;DKH#&_8b>p%_AdE^@3 zLP(ASqIYgP6n3POQ=*_HPw&ScHtu&nQK-?0+ z8>8|df?xb$oR$yQ8MoZfbQyr0elR$(MT?`-AAlb&Ga4F{{$^zoyi|S#Y2?CZrv_8g zaK5GIo1kiS5{V~y@0UpiT9TI|Vx*t!eaK9kRthIgdFvr#q?-1&t(a;pT=yrB*xZmb zYw8R5P*fjZoZoV$hSYocS7&0+G_-lb)kFC+Q>p$|lmq`}9KRe3H$HuG_y|Xz*Ykic zBp$CVTqZL0olc9!_rqG86IPu{8Iq!Y?GKoMknsM|jFN<nmkWW$R)0;=-v0xAm_otSVoWlb^RlPVJ7p1U|d^4=E>-zP*-Rmrv6} ze|&GPS7f_&uWb1R`Q&)TSwU~0v1a<`-)o6LgtM9rGA0LiJ@Ue`$XcxSFf)nQC^6NuI4*n18HDDl~3>VPbX+k7zOT>bP zjw?xBP7GAvQDt>BQx!=@sw8)=gBtaH=3ce`T>Xns6feL{J+BW8)Q#=W-7NmHaV*F~ z>UmFhh7MkTGy+xsl^XpR;qG_do8Awha7b-nS4*taqw15O=A{`zjy!fUT4*O~Px9G* z&%KU#?o;#N;>89$=?gplzj3XFNdj^3RMIHRL=~;oyK7Quk=^>0g#CAZ(QGGeUGLU* zWPaROHN4T{eRhQdB8Y!9jcDKvnUVfi)uLU;QxRVsz{0S7@3sEf+Q?Ls|HWY4W83@} zlSXj&#g|UeKk!d^F8}ntYOtDT?R^m4cwFr4JG~o|z8Zm1yM5aW({Yy@f~BU11L!v#Td7eeD4W$>lcjaG!42YE?~f3MI=4r% zoOf_vBji`oQ?lj_PxRf%pt#H=+;A1r#K4^1?Htf{euOeDW4^2m#LA%gz+PfcvYKB@ z{l5(10Q&Plb>;K9_`Jn-xRvcD^qdB-b$9yeMaHX`lv9~f(0}6fFn#1NHFDl)U4XX~ zltY}5+&}s?L_h~eET8)X6I%nfweCW?o!6vD{DiG}w?pr%+YfFCFf-a6yId6Ra|pe; zDl_g&Cv!gUMl0Z_t9nh5KE)coN>{ zg&1(j`%gkFBL`Uj=dI12!|rM*w?!U{waw}fJ_H(zB}-9=p|eJ;sfV<_S)YhAe7eDS z{-N^pB#iLATr#NLu{RO!>S;pwW=9=;trCin9igtoOlB&izD{7ASKh z(CzzkugUVut^bL;3>2f~%R9WEhM%m4uk8P(3g_CM>~SJy%}G!J2{hm1T1XXM;$Nx< zvJ>kKg7*&8803!xLR5KkS8}@!TpVFYhM@Q4tv7{NMwN?-8Ku8G-eOxwZUgt(3=6ku z31x;jRmhmiv^Xlb2w?7W5OlqdT#XaE5q-_MGSi%fF7Ds>Ic$5Otyo1~V#Yyo$>HZh zPZe}g8O%F1w+%SQX;*l^WxmvUQ&N5%JYQ;hfA9Y5s8Xx?TASV~=_EpR32`iLB7uC4Lj=X$lBnh3I zAtk%flc?{lm>QjJhL6FP*IzJugn z5FL63L);PtTf0G#iPK0T&aY7OESEL@kG;N>SRc>->6$NM z2j0(*rwMhfDRh0gf$lx8dvfpYx#D2>k7XT8!~5PqGifS5zl^X|?z;dW>t6;)d<#^U zqpau3c!`tBk%yTSPM>VZLXi$PMqeV1LgvwnFtkPxPgjRfvVg7ax0Xr^R;&%IPtWN` zA5SCheRx72%iHFEbeJaExY1ElK+?^&?iS>TAUdMBcMr@A%n{(^2RH+ud)j7?B;I^^ z7rkfli|k(%_b%e@w{>p57WU-$O{YdI+TV+mby<|-#*lt?XmB#+(b(wfKEBm`AY(B} zAZnYZD|DDnpBb>>Q7ZEq95BDq z&uh}x=%dYlNY1S?M_&pI&)5JYVBPFYqUc-8!Vem&)86BebiW?QAtFDVy}0NH26r_( zC_^CO?cMW|=e_!Nd;`}}wIe#2rjbs;ifve-VvB7)GI_S+Nsq$S5JY$8#w^grTZsOb zUyoAYclwpn;7>Ci@(v@DI(;8$4<&tHXlW*;hWslB|D-5>6-zKX+2bVjkSQ8?!9MgK zl=N~I!}?@~Kx<^NrI^q0srRS28Q~9lflYBLXVmE~H-TOQPE~(*4@#$PheP8^EAU}f zm+WSP;g*ei&p2L;l@4F7HzwvVyZLh&&an%n~F2LIKZGsoGGdXNS^^gkCKD8wC{ zOn978*5SMH1Cf!Pil1ixa+!!Ro4xRSy)@zYLPs7Fyinlr`RnQAu(hV9V3Uz}C;^ z-~Y9jxm+%8+u;v_3xQt^9}E{~dg`y&k_IL-boMLUMr9GA>}o>^!B)g*B8rgz=En8c zEK9pm`|y*X?2q_#wSx_BP5}w*8X6!2tqcCUtG(2FdmF>*`x6R~l!xbak@?Q#VXxG=k(YY-43Z+D2$B08B6(u7e=DG~ z*%5MY)s?k;<$!wd{Mz})9SNS2BBclkhNAYGR=Yc9eI@Gtv!DgL3xps?>l1#V*6K|I z@g6biLi{Ynk8TBO%+c=d^WA~VrcEsG)?TmrPdXwVR*O*orI~)IESKLQEv<$euHRV0 zUPn>T+x>w-@sS`pGlN?9>_rh7SfhqmoWUbl!t=cqsYqT!VHZ?eccRCm5S-9?!v&=- z+Jeh%?!&){ecKh#*;pOrlRLHF|528F&6}$#V0U~vK(#a_$BEQ`{zWkUKYenVJE9>7;rk|eSgj=7Uhnz3xm0Qy^^Hui9 zY7}x$DkL_sWncCgDbupk5VZMn-;o*FQ1Mt z2U`xQCp(2}Bg4`+`iC%H9Tf4sY*L~$W{*be^*Y%4MZV8(`SR)b@`qbsSWL5$uZ%GF zjM=n+$!a%_F=CE3MuW3+McnFQ1MtXU-E6p(YrX)pV>Dqtp-+cnY_W zd6t8G6`!Bvka-in3^?bveED>Ixf3Gl)fQG*Y`aenBlz0qAXALrc|ep17;{X9@R-8v zbs8||w|x0@eEHTEGPjTjRUj%~kJ_aIh4Cph9?uqYMFN32jbQ<|1u4J2l3al~zvauP z$SrpD^VHWJ3&Q$?NSEJQ}*?%ctYZ@oc|`spkf7Fia_oS2yFCcrly1 z1B*s!8Iz$^^q*A|3`=7QzC4t=pD)K`zthg^Ep3E}5G|MBU&RLp#o|IPI}ghR$q+u@ zJc5{|sde-oO!?>VTH%FCKcI-(x=FE!a+1wn)^OP3S z(e#KhTllu^uAeWD&p01Gr5^Y5;c%fFa$K72}j&d--OdYuktp4cwI{afY9wWwjpF#aIES^M$8mK{XJxHGf9|=N=EJAbe+>37@0iVs&W_;h*kQQ?1r-@eW+XFHl4c>?#k=+r=%NW>Ns-Y9A@!k)T?e6*WHg!^ zZ*0Y^BoAG^SUXT#3*y5Xg0uru4D^-_w7Ja<7f}O-7K+riTwU5)p$~=j{lfnLnTbiJ ztqb?QEjgM@GJobA=9_=M^Pe-{{NpBw-~L>F?&eA9|5hLVo9&$cPoK+Qju$*3*X&2z2QXa0Jn?Fjrh&=BsW6$h6(K|%>!6&+!pvWwM{YSE z-2liDar?!20&>3lzSo(znGVlddBXUF`MD5V%%BUKj&q%DB? z?(HOR|MMsL%d7R%4K@2w_Mb<|Q^^Uhgn&XATZ;2|AYPH?##y0*@^LUOfpalPq!6JvF303@uKISoQlV}P z;dN)hq%Sw?ryFYaqwE5Y!yq-CZt6$H z#2>jt`9vS*VVD%krkk(_CHEw{n=AF@X8p8Te_pef?agkSTuDb&SHOk(^L9eyq9lor z*!d1Y5E7ImLI=ua!rZa?6dV^A1}7KA)>ih>xDY`v_jyH+B!yE9gV&ovv`fV)MfWhzOU)&HxmiDL)}Pnx zy8SCjpR-l1*1x;@QGd?Z+JU#FR!L$ZLW}^hTu4yAh@yn@#CC>hw6)NkH2692`O@_X zew2#*_2<$AS*3p3tUs^W8yf!5EHv``gq`TK@^r`*qK;7+j`0vpxpx(Yp5vD$g-eM9 zH6}_iz+3_=Lp3!9T4*(@5+yFCWwqN^Fip$M%(wVx5R#GzQ$J5ljbNE2WqEdanY@g$ zu#n9z9G3g#<^B8jjTQHY4oh$-iHqcKEKeMcz4u4{La%=)7%a6{daG(5?Aa&#PYOXf zh(*(6@=2C8MOG9gPWF`SH10itp@(GrL@D{qK-xH#q@m^9#<5jU(+%Vb85aHSqaLE@AhvVfD_AhL| zf45ltDTva)W|!2{Sm z86>a_1xtQO>^f??ee3bw!=voDab>}uYT0#Y%du9`e(>NYhh83JWevavq&4tvcmd#d z;_(p^-~jm#SBQ@2sfOHC z02lPvx8w_uh2!BT_A)%xW$S;~Ki&T6n&S|1S*MR69`L{Ipy8nczO7)95$-tB%3$2U zd*s~dA7J10>>uCu04Os918r@$0P*WMeK>5jMAh@O1%{n}WWo%C-6V9DbE_=dA^3$v z;=&0(5DPo+ljeOMpEF#a$)zYN0HaVf+J~XyG=CjMy90W5)~h{-pd0i8zCK%x`Yd`n zK(4#{!m{D+`j_%&8Bbr$ID<6}(a6Gy{ft2J7Iu7JKjROc7Z9o;&2Z2{K}W6dJXyxG zWPkS|TMhC-R;OdAAK!qUvB@Mux{Nz{)tT7JFeV`qmK^`4#L|A!aY(Z zaXnwzl^OErpkBLubZKJRdfmO5Co{G%2x?@Qb{mG|qB!qc9iQ|^#ydJrbay9CA>?1f zae%Nz^5qyO>Zb!3wO9aiYuC~eZ@1sF542&fQ0zr}DnZvt-Ej2^*wM>@Xpn4X&Ax6x zj^3q_y~U4m$C*7o)K3-1wcLetu|!?CmVkU);Bh*Pg)FRWKEN|l}@@xnE+VKi1y@|grKE@d29@hVW94nddvm$4qF@#)iA38?`kMa(2 zYwTE)C8**5;vjk5s9+S_|0@ts!2e0iPma&S#*51^=serm*Vs>^+9ku}GMrO_zSE2N zLeCi)PjsKS-2Lz4)Ht~L7z+a;>_RyPM?`hUC>Rl?t)a7BdVJ2?r|sk+=H#KEGo(#& zZW*p_5X@n?UdWo5=92Q)dx8-r=HGd__BDaOFbg${6W zaB?IT;lI3HZAe>L8kYUhKZR}xNvu)P^hf_V7!U?*tOKbv=?^6{11&C*FmiFa+Qv+@ z7TuBr{1{sGj^3^$5iF%wRu?7}XP1$wRwqA7M_Ee?L)mJ}^v?7{7=|v>|Al>?_axO0 z`)^@RYQE07_w+vJxzGE)=bpS5m=6p#whwX|*Bx~(JGp+^cBp%CA>X@EzGo?k?$@gM@@XA3JdtC;1BMaq#z94|#pA zSblq+=4^r@uwC3NLk-o3i=cwX==$aF$juKEYOkB@LO z7Ru4DiFqxeK}|GB3gE`WD&pP4-20>QyG~EoQ+-|lFE5`t>DzEHBLy#Z9w@1G%48NW z4Fp{9R${JLU#Kz(+d1sDLs(*P8P~=FjiqaTe}ntR0cRE0Paiud(=7|WF6K9%o~&*` zcr_OfXP{w#T_ye($O-!CJ-WlTZ*J}r_{;R(FYiO2PYLk^_T*9^r?R}9cp$nmk)TxE zLLpP%2;{HliSvXw)n`_ot#Y&k@&p^-=P1m7357@`u3-dd{0QX(?jMi&NMt_owo5|3 z*FRbQ1L`B1uw2QBL9`9cGBndP3JQ)x?&0xgGBwP|*TSTH%uha9w%}Mi_NO)kopsCt z;=F-KhpRpVuFnPrE0P2CaLM~C`vWxqiCa z)@^h2N`CV)-;8g%d}i8HJw2X*q-RD2bs6@z0&|KP{-tbg?pOHJ^6z~N!Rd3wLBO$S z^XlB?I}nt%ipoO$T_Fqr@6Ha(vz?t+i7f@Wz?Im3dH=a+dqg1Lo>xfI-hD;v=LtDD zJ1>w&G!Wb}*b)8+tQFA+`M&-sX8b=H*wGowqLyfuX_U}X1aW3DnI#R-NCv%*Pj!=2C7QHA3)eS_FkwD{$YQAhj%#G^mTu*B-j@lfSkj3 z^poc>p?)_aRqt;;}`z4RAb{PNh?NI+sq*GA2=eIP*7E%lh$h$p-J6 zTv%Li*t$ErJGuTGKHrT7KVTg6w+F^JnMHgnlc8X!Y1rF>9YegHyH#;ht;kU+hIMes8y?Bjt{=Q~0N`J=28lA*{@BFxf?_V00KyGLc zZ!t8Y6OU8Fump1KRzYqU7>Rplr7P*iDnO2RteG&496k42uW71pli)@!mDYiGPEYHz zvss;xd*U^jxlu4~T5g*v6i4L3x!SVMHrp{-e}03%PyuZbbs`2@8wA5c6|oD!%H)ON zCa>2XeDX&?-hZL5qGBvYp@(xG@WX>|a8^aDBtJL&%tK{7aX5v}+zO&DBQ4|A>6bG(`TZ# z#t%;m-+#Mn7y>yUeB1c`r%>W+0;pyQN~bEcll z0dO;&0@kxSo^;(a2ZABC$8ooW$?$@v^dd}$sMr?UB)@sI%E<_*!OaUnH>boQzc3I= zChIHVk~evWKeit(Nmd4vNlu>M0^GN@#H<4M9;G?N{~!BNH))$pu}_A84zGYu^bDV0mm14lT~SlmoA^kU z@1T)|%^uvM@w{{OEZPX<+`iEGr-zhaLeBjQTEF##Q7qsqij4$vZMHe8|-k-8PCs6~sXt@<3^0X#ifJ zYmAfRN$PmA!`syV!4tdP4wiQ$JNkIFA5EYwXd7@ti=auhPDut>XRFK8MPGDqE!Rot zOZ7#ldYDe*h{U9xj6|jkl15M9Z)=MwqKDoV1-v>57)+cRO6SNW92t%_ZKebcv*00+ zh{Ar$c=+b=t|9Dvw_bboV3YM`PQFz24}X2U{pq{gt9n?#t!=0TWWvl*ogvb1``_9| z|2e!*?|%R6`=4`JAP%T!iMFo)0<>GRt-rK#D&;&Syo-d}DBJLr`-F##e(Lg)-+Y}rKBaBHumqDMK=C9B_F zbjmb!IpS1`Fy!t_OJe}Be}msy8?CC9{M~t5XJ==f4P zs|jyy6^trzzoPUe!!NF=Q8+RB7aW)HNzUF>+RWv|JxHUZ;3TB!nc-c^)Ct%BSx?@I zC>MIn3WN9hf46=q+e~h^egS%Cv(3$|&0n#Hg&*X`TF?3?Dpd&cCR-X><=ZmswITz)b-g- zsQHweYoeX&QRlMC-_2D;2Rj!&bSyaXBI%OZ;`2$l?=xI=YWu~J>N!LSaX=2^PR_?Y zO6O0|tG!Yf2EzVVIY`oqq>_V`lNlTz;ewUr2KTbx-AMfU)^1L@B(UeDw;(`zj{5M*?krKO|L&2$Sxi)o#+n zncgm~q*C7@`JV5o_kG^C-n>B|3azO3xLkTX&ia-=$o}21SrCi^<^Wntv@SlM$an>| zsxUEcwian+o^b&tE-nx)J^2$<6;@yh;lnd1EW~VYpZq9n|C6^5U-7CH(@X#7XPTLJ zKi@#X$DiK)B%UQazkWRZDxH+?1vv4(uNrsXACLb#o=jh-0d(WE0gBtrrgil9ojoDK z_m)K9vlLl^4G+uu@ggYx$C95n-TZyT_}C6>yz@4jDbEVmnMmZJ5MywiiSwA^Fu%eQ zWFXG-nKDs_J%8z5*AExwS^6KJ9_KAl*}wZSP#@v z4OsJ))wG(nW!uS4AR6$|o6zL@H#G{q^A5Y_P^u?qMx{r5_@EDnVfSSytzg{ky{~EmH3< zISG2j=?e(ZWr7#Mfn|ZYNne@+1LX0zKLi~0!wK_OHn}Rk>r9v7^$>oWr#54tv1AZ-) zPmP)NvCQ*~NGm>gNhhl73+p!(|lwi6D8DHy?kYV`#y z9(4PM4}qQU18+e6RX9}m*R8G9?XB%apuhNr(K7be4KX`82S9; zP1um;k%fPd+aT(Nf@RqS<9$^802Vc2r7hmE1p3(l5n zFN3N47|aLpO=z)8Zz6H2Y@90&ubB^pOwc@K=IgVpe}2B}e%f=3s3;yM=%W7I)%V}@ z?_OC^bCIH2q)~@h_f;g(&wRW;jn7uC0`eCkB(843&A$kU1W=Vh6fSUp0m0IeD1VGb z*`Hzm16P5V@9nGx&H}@YH?LRaVKp$tDK?L6!6%?$+nhQKC(+=6FASA ztfDNRJ5IEOxf#;nQS*Skp3ey70>pQPL|>Qn=U{ucG)W~i?BC7$>2OXh!k_rsEoXbh zNzvXC>8}s_csvuNkM7B9Alf>ME=h|h8wBoDC*IqJMT<$o*}S9y#1W72hhyx&%XmR< zhTJVfKr9)}2V*$i=@bgs|Hb~}&hY5t@CcRiaQ>xf%0ky1#k8m&pZ7qekgLQm2sKi# zn`0q3%8hX8;S#7^irtCd}uAhI4M}>Md9A9L0MApc=UB@7ro?1Tm%E- z`q;l4pz}jSL=vX$qicb^YdI_X`>p8Sqn)#l2%o|1?C^=Y_K|S89RHys=WdWywjn2P z$juTI`#+3#q`FshJiC;Z426ZTa zH4`AX7TeU6Wo1UVPp@_v+stDzHbY}r8ev;%wY8W0YRjQpkAvwRkNDXqe;i9&0_d*W z{@sxkFg+Y@5AdPDbt&61nZH~))@PP=!`{!ShA-6$Lx_V0#p%#reg`w<}`0l9$Q+4@@8d9r^X0tj&>w3wavvd2eQAFk%q+^7nQ zN7UQ?<>SNov)Ygel`Dx4G>7}J)(i3u5QF>-*sFz1VaKs~&l8Gr{tY;;+;e#0OL1;f z6G3SzMeR~AXP5#DvL4{6yT|%y&wP(p(d3-&clBM}exJ3|cl&$i?lXru;607vKlY17 z6};!}Z22laDw~K1TPqPtEoY_DTH;I2`^y-=`}x(!x1axR|8m##L0{ay>GB>i;Q-jI z&u5mFHU%O6S}>TZv-U7WII&B7V>85i`F!Iq_Z$jN#OP4-=2vC{#)VF_z7~}AMNEjX zXb~6AmCh16e;f{DQj)zpJvn~xX@BoraiD(p9X~(fvysSvGzqH%JV(@AF}%WYIQ=hv z{L}vBu09kS1WK2`c-wC_U&3OKcm3m&U045; z{@&kyEBbpwzCRv~jKCP;5@i}6v*dh6N5aLH$}9Iv8~^40)- literal 0 HcmV?d00001 diff --git a/website/docs/tutorial-extras/img/localeDropdown.png b/website/docs/tutorial-extras/img/localeDropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..e257edc1f932985396bf59584c7ccfaddf955779 GIT binary patch literal 27841 zcmXt9WmFtZ(*=S%B)EHUciG??+-=biEVw%f7J?HT77G@f5ZpbB1Pku&vgoqxemw6v z-;X&{JzZV*cFmohnLgcd+M3FE*p%2vNJx09Dhj$tNXVWq2M^|}mn)^e9a~;bs1CC4 zWs#5?l5k+wXfI`CFI{Chq}oa9BP66(NZK0uiU1Kwn&3K0m`=xIMoxdVZ#+ zp?hKSLSSimjhdEzWp#6Tbpr;2A08YY9vwczVR!d;r)Q^kw|6h$pbtRyO;c2US2)Ho=#3q?{4m1GWOCI`k&9;zl9YDhH|l{oVck{{HdF$xGeh(%RX@ITa1V-QE4arPZ_3^N0KUo15FS^Rt74gNyU?f6HsD z>zmu#+n1LY=NIRf7Z*oIN2_aF7nc`%dwaXPyVf>#Q`56+>svGPi|1!&J3Bj8*0u|a zE61nDOKTge8(T{&>(jIU{?5$PF)%N#t}iaHQc%;Ky=4F7L{Hzy*Vp$Mj`%zGZ+7k< zCpRC^+V1HYCi6}{?rS`Ew80CL%d5-LF)(<1lJAQ_QE}I< z?$m+XE%JR|)Y|g5*Z=3YjLfXkvht|tSaC_|$oh1*A78S&%grr-Q|oi0ai*n%^?I3Z zz4Ifn)p1zW0ShuJU zjT*W!;4n~Y)3m5E=4m0n9;cN(k*j`y5!~j2)ij4x1#tx zB&it>z`(yY6BF>DU9?)rvOb2G!4AbPa`$!ju_}{}N=X3%ljy@XN?Dz5W~L8#vn;(% zS0y`!_FK8bT{5iuza9iPzyFntcC0hEUgCyxwZgrs_lXv54ZHujy!d4_U`~v!&Xq6w z_%CfMkDLt!D3SDYg>XEZ!YJH*s~-dg$LmS&Mt_;Y7X9a!>IDr+ded%2&q%}2^ODhk zoJMHe1;<*D7+WnelW=pb#;#*9m22_D0Uy+B;{x z(r=4T(e9>b$HL=1ZhtTnMZ8m?T*4WlE1nANJoY~M+S`a~oAzPxq?IY|K;|faC(Qf6 z6st=g2Oa&+>GJF*AU5<{Q1pIIjk9IOz}i1XThs0R)dBg}u}I!L^(JejuqE{$Bx0WH zK_L%2hekVKCo%({=C&4>8XPbm?HVjtj7;pR;Nl%bO7u_%gfl5w5S;(8b>qCb9KY=2 zcH1B8#T*pZQMR+_zF|mDvyu5p%arE^>?K|9F#FDuJCyu6$KPjjPBMq7j0f$|h@y!QXH+UdeH3iv*9ArYX^V-S2rxolaBRROkUH4!AxVghY-$mqUuOg%w5X}J1K z3LIKED&GtI+|Bu|l2OgJXS@ z##5m-UU-??q5BVBs3e%jt&;*!MXilSO_r%{gmW&qj$2WWx8M1Us?Tzp=Of?r=^y=m zDDr>5Z2+yUUf9O3Kqm?KxT9VJX#G6EP&E+e7EkxJF5QqcBPy@TsIFiD!!LWKz2ftR za<|^DinsXw>aBe|0DWOEi#5cV&B>!$i8?+vTr3ZDMK}XFeg)Ime5=*V++LLjj6sSf>5d+I|6V|cU`LfQPC z;p|(TN|j&~8CO`*qIi-79281;uL=cj-kt$ zx5MwWh>2LRlqjdUEGgk)P@$`Rs3-3sSlqxdxpG@!K`;a)V2m#wvau8$FIZuT9T00v znI8L>LHCkAZsu+5PUedUKs5fY2Ehv7Lqr}Ue$h;p6jBeeweEDUn2p#fwkvxk%Z<-6 zlgcD$>a-9H1#>^}Ku>>wLa`FkP^$V?ys$YQ&1L$o#0R}|{e?+I{K?~0CPz_*Bh#mo zh#!|PeV|ebfXa=JD#~>$?!*)i)b@eZZ`$qTk#-n$b{Cnhx2wH9N;PkqOwfS5FPe4A z!^5G+7=f|QUkN8gZmRRF-gxA&%`!7|FLGzf?uPu9E>P4d zrO@YSB$ z8Q{^@GSty5G&7xHSPy#pErSb3Yym^l5+QhvVlc)ItslUVgKOTQyYw8QX+2%`A%uhb zCJ{CE9{zUB(&-v8uRN|49S2Np{L4XRjFWz9R?)%ikl#d@WJtzM$=odVE^A1_CR5$l zs~b7y&?qM}RqSq1_-7&^wqiGh$yZuM2alHG{5LL=^QiF^u2prn!rcZ9%AF_!mJaxS9)8?8ha{9;`m^(Fx7`o(9*^- zI+OEv7<`;JEbKrNAh#EhBOA3x9E1Hr;lS)5pbY@p_LBMGn<&!Nxl41i9>dX%V}P+N zR;}+{G5WqCjnW#@f9ZNd^d5R<+ViQpx-L3$P}Nkiph3->K~K9)Sw$@INj*8YJLj@f z*+Rh+naB!_+NtSnzwWfLhq1;bmSozM80Xik(oGSLM*c)>iC_Wvd=JP|df1=roC3iU zoG&xR@$6d-6s0^VR}3V5OFQndgqfbboOay9Tf7RQmygGWgZ+DD(=|p9Aw+)O_j8?HRA#~+mIn^!H zQ6fcNW1FIjQ#SN_nK%EQV_F{VV77VfT5B(ea{vC|K#&-RTdcH#OR%(Mr#R1?jLzzq zSC-hN{(b^Ik^Q{uB|gq70;JUnM+#nmHCHA@PxC-sYqdnHZfEu1VHP*(8?jf)TsXH7 z`d(w{qU>V+81-UywGHL+AD7SV`|6-5PENL9RC02nnu15q_;*RRA_g8|!M(z88r&2? zCYs;1K=%c4QceJr-h+O=+K2tbY%HGQfyO1=9--HP5(yo2@2ad|TVK+$67(dBRpKI9 zcTvYDh?n^D9&qCvQhZoHb7DSvql}UJ8B+>~m5-ISatyypAR9WnfzbiDmXq*ctR3Xu z(~YwCAKYipx{EI8!HwsIlC6i`0rhcb>6<%+Cp)h@mK*_1d8_q6dg4>n}&ihP)NGiUvb81U?bXk&I< zbcqui@YB^CK-jFfu@*XpEERc^Mh(aJ)LBA@| ze4m|#Gs|Rc+0u4VvgE2s^$ ztYjCc@_u6&>iu~fe+ed*pr>hTdj(LcVf&SE`t2uXleZ(mhZd7kd|U$5HrJHPQ@IZ7 zz1w#&@Hi?VMVg$?DV~d{6LYoL8SFlWmuiYZxE8-M?^q32JSt7GoOVzZ8#I13;Ax`h zy=DXkH>H2B>%O@Ual0AO#Lh>Z`q=%r{iaZi3fZKcmBtmff&=e!GF%sO1~^L| z<3g?B>etUeZ?Suv6A<@bH;i=|KtG0mk@t4!qPRX4+^*osf+?77qg=U_OjVUxbTvh% z8DC!P=LlXRVFEd#m0i*Ka(b7e+3E&CC^Yv2#TgpoU(C>Wsp4))0%aRYtPxSr1x zO6uJUAMROWMj1L@;~jX6gRh(+e1ZqC_CTY4s&GfB-E;b?6+vEb;^bSE6j9xTFW;oq z9(1ndc$4}qdAB6ta4BN@p|T{**jB2P48}=Ya*Jc5#3mv|J&XRD;~yH>^DLwT>bp@)BbsVm+*3t=;598_Aj{ zF(?v`d_@ky*e%9dvu#A7+LtE~P$5VDCRJz{ZCt3Qh5aQ==>mF~k7bTCZxZg$!jnP8he7?WmJYT*1>c{*tJR|Ie+ScEevd4@gG>!gnL_ZL0 zKC)4$4wIXHIG~yE4+vZ~gh~Du9&92xJVUy91zt6P+$SZ9%)_wNU7KW~uGu2PF`KM6 z)UjHJQr%bRkMmIKABTD;BRcKhrdAbU;gFURvdg`TDW)T{)k8(vFbmtSAMueO{E8RHEQz-$F2C0;smk?8Q*e=qM%6O z6aGCJV;h1Tf3qvPEYi~fsz?&nlrg71v(eKqA!&F7d&p(^Xy#{`bl-!6%zc6pwsB;^ z+s#(uj7tu(L!ti&l1T51?Zuxg`16)sS-XNZm6tV-9#MfVeX#M39*XRuyFiJrxU@lO zA94#H%u0U~Ea9b26Qf{o;FeeG*!6uF*bYv#%%B^zN~9gqX{FS&&Ba|4AuSA${f^sf z7tg9}O%6m})g#&j5f%_eXA&}AZI!vQtzb=^sQxVZi~_}R^pgdM?5WD3%5Gx)%~qaP zgb4y1pEi3Ut}qG#QQ8SxhEkYe1Iy%QMz~|VS zKNsn5WGa%en;uc#7;LpDxYo4^@zL&dT*?Movr0f}Fry~2?+=LVy&$9SKV5+@SE-{M z4E!tmqebqFV%O~LO=L7??~zNUu90ECkq2Dut+Q$C#QJ*uQ33)=L?sH^oM|)e*HvE5J+C=qp79zhoRrLcNRA%1 zo?(m~(so82vOoC7`kQMWO5~^(`_b!C)8yq_VgnO5blD*sV`=DhQ}{$VtHxJJ@hixJ@hcZ z!Y6lPxZ6KphBnMJ)Ki2qFXY=iKs$GnX#1@Z7~hW~TuZju?)u=y?>z5W?Gv0-coA#k zCeo>mYl2HbT(xw!L&23l5KXaDk)yq}eBc&oPdWOPI`+f_o2cgW5QeU+)?Z2SHRplP z^{WM#a*z=ndtAjrTjbW0xE@*Ir~X+Bi-n#;6t1um9|^H4v%4b8X{_t71*TeupTOxB zM!=Yir}l!cM!GzQSnjS?@tOr){-JXhj8oH5p=g?cX47@jYyLLVq#|_Nsv3>>?X=ey zqHoKr;KTdI-GBAo?{+YUsVsacvsXS>8d?dLdU_)>MB*glDaE}%bBrd^98i+k4NQ8s zc0?8Fbqr&)Wq3Wd=YVyyUH$oZkbSRGYQQj1NofbRth{_t5aE##Z zRgYXbJ@On89x{nXLRlW`84WcfoXw=cPcZZH9T^b zcb#iuU7-qyv~G@U`}AkosbCYozUSeB3Hxyoirpqhcbvd|soGDf8>z48$4OE>XaW4E zM`Bd>uV&vA8~mC0n0*yWn z!;O|1HnCN1ghEB898BR#@4Bo&&oP9!4dcdtLZ@`un@&0 zzvF-GJhEY|FLF{hrM=dB7|h@3bEZZVJc3@GCJk0{ONwS8^g2F0`roJtV2uvN1O)|| zIfYh)=}lZzT`5BbTHcM6zo=WwB7-gyvx+Cm)a}&MT+1M^^h@h5kMVlZF*~3?Y5n)L zG9~s#<;5)1%>+_Ny*GZHAebop+bfp3&+eUH&4)I7Bc%5<40;DxP0G8{l|7Ufj)b!u zw?zWRNHyLJzYlCQj^pLwN#g~68@bp>+KA=l8QJkW-|B;3+XPeez-@9TIs${Q*6_9g zgZY+gF6*%)arn3AJUkn5bhfZ9zut{n6VIK=XKt|=rtOVmc&6zImd8%#b}Bw)vQ<=y zZ*)E`F>yPlf=T61Cm%u&Swgy**c63kVp0V|yM7_vkz7jkw+1H3?_NcbXa2QR`&1S! z+&YBgY5aZe3Oz3Y&y0-J_SoE$OJ?^Y5E^umyENba+t#hf=fjWb@y_QD-S_*?k6rg& zYCqi76Dk6v!l>?hqKLvuFrKkCcX`eYORriHtB{LekCARf*i6xO%HyN*j5mwg%*8!T z_-nF5R#R3`E%JC%un?Z*bLKZbmC(`y?h5hS4~y5*hgyC*ji|t|>+*|`-dcqG*G|Tt zEST8(?OF|TW>rp<0OymrGE9zAlwD*|y}VO>>~H8Z91s2Imik`Rq+^-6$BW;-O~_dA z!0~$@ir)8VZEok*1Z^bx^25FUR#w|5ZBYL3o!iz3!TIR!4dM0kJ3M$Uu6oT8;CKYy50-UD6m_X=r8s9+5$+sA0zy6pqH_&Z@W^+??+HTsDpji* zpJYPs-t|l<_3g9}ngwho*oRGjLvmgR^?mB%vOAB;nrI30-@eap3v)1iCsy6LJHpO1J< zyJZ4Wh4TL8e$;A)3J{xrvG(WSc=))?Jb7Ude7PQzrs^QKFUs80=y)usVamepIs@|w z`Iz`#mm;4!p8c?~+N=@YBv*C$SE3I503HJZ0R|PT!IyVtgvYdpEy__RjV?qXKeZS8 zQn;w-0EHEP$J1*7n@+9+ndkivReVrStsXO#HIyz74ueJ3uc5Y(sVEe}?RntR{lQiH z`Z!qQ;Og%AD&~>mulH;=Kz}3H2_E@LZb@~4srs2{vY?%@)Kl!Nap4D79D{9}Z!`{& z?#?MOm>og((zofbkjOl>6O9@pvqoooVcjc^C-#xV?L|D3rXAR!rX4PzRkgx;H70*D zI_Pqi!x-h~CVp;&e0Ji8#XXONI@+S1=SSfqMQ>WVhhw!ZpqKaFLfG@O*E!;9JweoR z?{TX1XS6B@-~)hQV+wZL_soD`{+?KKnJh{Y4z>ugj&n-b6_}jBe(jSLX6P z&9H{W>AHrLNjvzbPKRmV@tT%0mYUCuBT1kvP^GO=`ICpra+8UwYXrd(pWPuzm_4{& zWk{u~y0Zv8Qlt(vtPO(#zX5n?`VDW3Ct(plTSM;$<*Wqlw`Z7-AN6CITh2!btkaDu zrf!`e&u14f%tSP&(Dnr<9bp(XcXW%tYO*s963nBWA=#0746gunNA6vAeP1s zh3fwN_Xo-D)nJ}kr8L9iLhlp8zQQ{nY4Q$@E9VtETvY3caFqEe?wB~cpWg4cy=Whdd?Z? zXPs;EKDvGsP6*bHo;Asedj+UOAyPE`Cwl8av`E7KMRPx4{M5Nm)na^3~o1fyYQucv~N{FBO$#$%a?f> z_2b|tKXBB$5)5npHFNe?Zy-grTI8sM+$}L__i>e2nemkwx%9r!i}lDhBEL!$_8+d6 z#LJ6vr&OO=-?Wf@W*)yvCLByyX|NQV|ecCy7=VAOB)9BI*Nhl6$m2&;G5gX z7X%M-WD-iH8(`K^IByV*KC4pkE;Q%d_{*#4?^g1OlJz4do+x=4js7@ z4A1i5J{^EH#kWeooG$|j7@#2|@kwpNNOp2q5tS?TUv|0sCwg@^U#G?D|NVyEHk3@4 zh9QWPx@!?z6UooVSfd6QY0LCJiII2vLNZ0~Jqnz~Z^l-ou^A;QU;}AhM{s6oqmA>R zx?|OM=&u!W1Uio$0m&-Ry7O|=MSkJHZ2nMCm3cd2v986rcYhXj>{)~`rp~In^`jTf zFrXGkn7tKYRu$h+~JfC4LO`D=-Is- z`O52#2dQHUn`kg1yFQXPBn)1doD3>%Z#Qc1db!Om^YRfrJIQst z-;fRaT=uTy2I$-qS|{FdP~V|NDf7ik?ZkYCef!_RSVV*5*a4(SshTJnq8S~a`-xao zsx;}%hcFK5ULvK;gHS_-z^^qx#frvEWpEI~{rtfbuS8wSnx+wfU>o`2dC=x3`D zBhoCot?)M$PTo$u&5L;JYCKUEb(v4VM%h4az4C?X?!Y6cb3KdhwS}?e9dC7;HdnO7P%wI_DM;;s)@@Z%bXbtAz>;d_JUlP#%eF{9 z&G?mfv!)Kp4BGm-`S$V!e>YW%_7wOu6Y@dH03UOV54u#?t3zN87%+2DV4y8UA)tjRAF;L2r0P4{}i zS>CSrwAQsVg`0^P+-P9(t8Inr_eUS#5t?4*HluhdNj63cJr5&s250OW1_Y*Veacuo z)0zW>;IdzS14@>TV9}D^5NujBuLsVE+*^zGaRsMzd40GW&lUtN9c}wb{~oH-rn5i@ z8}x~^(V56NJ>0RjWulsd{#z*g#MP3;$Kift?|Xb^>Pq7n-uera3;fa&%Kqq+sTISU z>9I?T5p%nzkJI+%EB3-pvu^_`-K4BPitQJr=<|A1pF^2$^d||Im4!Lx+DZc#;0d%Z zU}NxmZU|4p(!59eAHdzA{rqw6Ka=ssc2YVTy@Kr%TweSx7~PHI0$Ux(MH2xP>83k; zbDo^brmW`!))Eo*!~#*~(W4nwS!=Y1;yzh_{9+ERu~TOO)jk9Zv~B;)rYQX6mHFEK z$FpwAYy(lY1r9y+I7I{>9?geW)UF1iXT09htM#|*5w)gCZMKyi*_Ji;8TO`jkr6_D z6d^;@Cn2~1@1t9zQh@LC&YnCIm}xot2eOM8;p8qUQN8+;{_dBN&^VM~s_~5G#LV6m z_E3xKqtq!foUe8JYAMWpG6L66c?}#MBe-snYIx34#${6zQ+joY8Si;6OdZ&ke9RI9 zhJVE8S27lRcxM1to&zo06ulR~=)s2%EoSb-}Kq8vZm%56`3bWG&{95m-EEyf%f3 zH>Hp1P(-{>oBt2RmrZ0^^02K|$)u`-lkn!CnYo`C98s@Jf)-Nt3YGS7qu+WJ#ig-Q zFrQrF(9BS8SkgJ;+Ad7Nb-pL%EFha^nT1{-?E>u#tIcaiqZ19=37#rTd8pgB7g#`{ z3R`W-FmER}xBCpl>6-zNKPtsGV+;sy5|;j2PzH**0v8xbiA$I)z;nGF=f0kD;9o80 zk9RY17@+hFh@PzHbGN#U;3$|?cr@7<-4>(%aAapZ`iHIwt+VtBy0LH(1}{C)3kg3a z$axD|Iyt-X`@2lAY5noiw7Ges2e_Qy#ZG7g7!r}~R1hs0kXTsZV6s<#V!mFs#>11$)A=<$Kuz z!efePeRv291X1dfQaDLD&pz&rySTeJ)gM_}RHN4$p39$|V&}Hy&}+?dW^|({y!MySY<7Jzg!O zf^s9Ppls*TLgM-SI9c;jdIIB_?_E}SC2dbL5<#e@~e!>h*T}3V7Qjuwb}kpd$k{i8yIhNxcWp5 zmhr}|T%BZqGQI3rUBDr76MVryhwI4_s>U>$O&%JFqpibpT73JynWfVyP9vAd8#TkF z@b21lX~Xp&JvEw!njH%gzR#bLZ(HQc-x>V%ncNiNZVJK&R)GfUJ{=r%@BYj|e?tAE z^QvUXJVicpo4=Ku(9&oBMNT}AFs6q4)YmcNKs}&Yl3qAPrANKvAX)cQ0-_JnGLH^% zib2!LEZ+!2?9Xjt;Vsr#lw0vn26t$134ju@;-k>6A|D<1f9{NA&6lpAq^(bHU;73`4+N|^gyuiqNV6V>4tiHuh2}gS>rpliJMYF> z8oV`hL{!l3Cr!jFuS`U(PLYOcg;mf+q*tapy-Rrq73i4^Zr_D8w5!nj+I0u!FF(jA zaa|Fie9MYyVD zY+|f$aJ?0^#q(7Bv(_Rf>!-!26{dkm`vv5_{yhqlfE=-JnrnR3CE&==9oG^BPJ~kT zwR#L%pm6XWo_o>~-xFwsnFCS-K3SEG*9n3OmOIw$y|;&`Jh_54%d_jy$;Tc2Y_spR zsaIH2IH@qw%s;q1T8%_~*JZ&ytt);Fy%vh>g z0w_CsOn#JW{R5GsH?OEs1xr47FZzM7B-{&lNe2bAnJ#CYkWk}CK065tB0jzXv_Ue+ z&!kU}(r(0*6z9AtXe^RO8lX0D<%I!#-wUlmC}2X3R^;0)cuXyXl#01U9aAYGBNq07 zQ0C`^>CvlIsr|X$a@#JlI=!B?psUQx$bJ$^?{z*pe0X~bm^`c#V&s{0MlZ2T-y>}F z;qPquk(Pkc+@>~ButddAyRL%Hp<*0=QjboBwPSW-PHOEB-@Y}(p8aa|yNnqY5iwd} zMW09Non<@D_S6*Yt^2H1H_*KaVR?1$sYP$fe%28z_TYR*uvmX_{;5wg$t{cwp()qhVL2-qx3)1wM*a1-Qko7WOS|m_n5#TglB_)$&TDF_|oOK~F z5`+$vb~~{DgX@<_1p#;oVwb#0EZ3TI6$r55L4sS>BE@dTA#G0aD>84pQZg}wEWXX` zi!o|(wQ#4Y+7TC_zH2&(JiwOOYq`B)ZMOS$()lGjP?Re|ONa!QYMvwZxST#y zqxy;V%ft%25Xi@T@m(kD!pOvW$-@7ISP-Y%N|Ru>0)+_1!Xqh6yx_LcFNm{O`PE!f z1~@)qX~N_wIEb^f5u-?lm)di~;Jr!!^i2p381+NQa^Cc41Q-KE0Pi#aTB>o!<@$c% z*Q&0@cBXHDTZ2s@7*To0m*BYhWJwxEsgU+sx@6~uz6~lY%RS;a{p~AC-LG>IUop{T zr=uIPav^B@XZ77ba;qQ)w|Dxt$Q-fY!I+bh=a*g~Nhdb4cY<~1N)F-&Ui>SR1l(Zm@ zU~{AX%FoF4u=?X-SNV(5k>HE$9dJyNJ1i`5o7!u7exC)~47YqFkDvB6Qvg#`GnW$m zy^C0qY~lL3`HdJoR6L$C-K(+><84eipiDHzaN)Qv$Lvk($43+H>IVoTphDA%<1OV7 zN*wIOIb>eQ)`8RyzvwEjennj>vn!@tYo7b3bB?40+SdR)E#yrS^OTn6TmN05HqK%l zP)ZuCwf1Dqt9nt}M75{7)xl28WCdmP&nv%F5L&v^Csh6lR4+6qW$%QBQl1y9g2m&zLQodlxDQe5t ze74A-pBpIlCOSp+vzs<1{?Jh<5)t`U7lpH47Ax0o_SFnzt-ale`H{M8h&qB)qshbx7Ad#HNB$| zo={%npyBI&{m}+3+ngQmW@l~dYovp+my{i|_PyEoYucnl>EfHm=~;&)!6SYGXW9S; zu#fmK+2v+_G46lfe~J+}-wMrzj+?*^#t`G>E$l*-E7%bPB)Ef578L#cU|%dTi4@hk zp;+bBv%g-&D%NlYIGgkRvGc3A&8QgDxkHez9M?flQx3A$cKc(&?EFW$uDMSdb(QMw9odi zQA?zO%QwiY&D&*2_|La;le8f+v*;YqftP=UX(~GO>fBxRS{^y4gbh*RyJXj3%v!%! zELfdXKw~e(B^eo_RBX;Th4TrEi|2p2@Hg*5bt%Y7ZIk$P-}GUj)gwz0gIBAGiFNn8 zU4&Na+V|69<~TqZyxqSPaeGkw<_`ynX{4vBxwIX_Ypq#9SqSJ=W^R4opKAeSa3L{m z&lHRtdQy{5Ggy~SFu34>`lJ%Zqqg`)p0E)ulwxhQ-;}L>tXPKb-xTPBQs}1)CSM*$ z)G0-&fr8_TI{4boZwExp&4Rt|u<&mI1_Iy+`yv2(?Zm>&!E#z5*xWy{v=^H#tjEA3 z;?O-=$gFu6kw*5=S@@t1PtJM?AR~Jb<+?`D@ni^f9@rf(6M@{G_~V?Cy-fQf^8)n? zQMliUqyBPjXiOCQo#z#uU#^qooR+z_tHzkiIsIG6rn#gWN}koO1iCdnJ2E?}15?Vb zHv1jpiRE-A-RvipUQ>D1lRSvmj z7W3Og%mVd(!g)KZzdxx03y^c4IMqbhs;z8!D&FY;i56b*oQ6$WJxRAsvOKW!wE>ua zD0mc=bW>_*_Ph03EUervAR2#dSHw8J{!GR_N!df0ZL;vK+=3WRYyZ#GgT>l0+k}~1qIqt zS6WmMZM)!rz7z_m`fK9CHVM8F$z&G%jWzFH!hm|FYpam-1QF?Z)lPOHi8}0f1o9EZ zDHf!)*@a?vnvbdJDr!`&Cqj=g-f;y=uFs7+Jzk$Lqc5IOB(A-BqFIgF5T*Qh4dUC& z&KPT!3?JZJ?!2FGI-p$Yz1pL2ZT@|G!_!$1J@*9lY>pk*)lpl#C(!j;vJ^FY@2K3n z2bIo|a*SE!HzHgWM{6~I(^a*s15DV0tUv$zES9Amg!xeS8?y}$1Z}K#^z*n0>1~He8ZPz~6(W>wyBjvX_I$UA!VL?CFEa)<61QoPZ6E_lJpjc$tmFIQ8ZC{iPDf zO2-9y&-i(=bBR|;{%~gM8=O_tg<9F|DLGA&TZU$Dmt&g50M3#7f)z&Uh;BRwc9Fuz z-1wDw3C{{c-~!Wkhp>&;jVmvmxQJZfG-RppOg1^@pFD4B;*!n~lLSmHhRBGUZW=wL zrq<~HsA?@Fl|25*Z_6NPzj7X+}j+I5Z=nZ2_bWFC7 zTuxY^a9H;EY7yk(wd>FO+r1&Q=A6pE#dPEy^vWSAqgg}SUq@acOCxOw#+d|Qm9XIz zRGFSu)D?W`_1iH$=?m+!uJ;FT$Ox9sW_Mi@heywtUNevsjY|GZ+9y&g$4FCA5uwfk% zf*2q%_Xk{=xlxR0V-lrZ<8c^ny0kflt5f{jx54mj|S>kwam*Tak1b3;( z5uPT_RKvI3-JN1xNUUV?slZ3MO>r6QL6oc6t-jxIO{GxTrzD(yK)QDPpLm+v`7|p} z2gy(VZGC&YNw^Sa`UGiI9uXm!9PVra7Ew3o^o&h~XSGDkY zs;^`*cxA6xHK0$Wic0L>UEZ->|DkX6j1#<+RIHQm=vtR9K&^UG7kBp zohssHdJ&9qvGa3a$c)-8t8?K+cH6&N!v~A?-<*cwix;^Kx->T5?74h9@7rrK!RqW( zo2vJoGt#1rN>*x0wCL^Iy~m|a9o+HOx%%|#GJ$IR^@H56PS~Nk&64x4VbME}59a@h zAqcjHo2qUpv4ru+gtljF5cq0UfGkddYadJBa9qH5nTqNu$*6Eyt0)uW)o4o zI;X)D{>#dI8(%wELz1GF@W7BU?iTh#pd^;0(7A|qgmkyuW5DgLce~io- ziyf8;ON`-an0(auAd<+A^E&OM70amakbMh9ou51y1A4-pKz;ftECew{C|lR<2EG2V zc_YNUU-=dDwpU#60DATW|2Y$&LhL{Md zgU?Q#<3)i(y#qZ1bzpAfA$a(p99$lv#>L?Q)GTy zvV36GhERupL#v>^msU5ZmKGe6Pb0Y50Z_*r_EQ}YYljZ+66G=_SknIB zZ29q((LiBZotu{WaHM14bGk|AaDkw7pRRF+J)Lu6k|cfbwnXs?-X|W_s!|@*zFqbI zKH(l_gt(*O6YGy(ey6N?m_zU{`f$GyG}a%6%QeTyYV_*9CTC!O*p|m9#!SnxQYjCr zx0?Pz4pbv$bbm($)?Vpu@0tzWHsS2>)v#t> z@)vmMMS@d6sl1*mp^|5P{sVa2Ydr|^bT4x;;m;G%!7jv|MnM$?)5Ax-e8U)PJP1|j zw%heI;oCzyygq;2y=EfJqsY192X~vsQkXUXIO-m*UbQ!I#`v`?SW-Wg`74otU4C1v*?+r{tKmsUFh+cJOFn%ei*x1dOd6 zFdTHO)IfMfuFw1>5}qFUpQ-y^y)mXc>I%0whfG<;p=IXi5i)%>S(gUE5DNjBWKBzr z_#Wcq8RL0%$M(|1pAfjAhgbM^y%{*VI1Cxpv0wt>7i8%;SsQ+%*i3Mo@%ohOIdc9n_pG$ewjs26kJ$SwQbo^Sk8@-{F@9Fe^jtAAGY004(QP$Jw zW%MMJ!r8%+p2x)wEYW>%pS&FodEgu=HP#p6`0Pp&o4ydp&i>(Z~^F0082|Xag}ZxCR2>ZQ5t; z>A|WQnDS?znrt%Ye7if=pzl|H131>3+~^IjMyPz5ZIm@Fg=5~D$N*x02W!5TwV`kb z5cs|uy{8RXJNs9M*y;%C*|n%;`^I*cHg&PuVYA{FO+N1V#OU2-1R1gU@ug@Xa?q>b ze*(Sl%OV@%(h7UJ-Bu0-x!o!4QqeLO#F)tNvHiyS;USp!I+M=xg@Z(rv47_0_;K4l zshut-0EL`c=&=BxhuXPiRDTm2%{M?W6#9@tfK~EMaZ8WoQZWLcVe@du#-RsW4+z}g zO%&Y$Psw`fY1m|z2k?BkJbNCMBPap;?iM?k=FSWB*Y9pWRVL?x;LPus(N-8_gAb^2 zM!(Sv0At)38Cm$o>ww`vVSsgov{ zCdYVS8Njokqj9l98H3CsY7CH3qo`^|-M;Kkwb$*2&=wdc*1-MVk+~=0au2!?|GVoi zlb*^0KS?Cd6dOGkZxX~LQMUMnNLwVqKjApVqAuG@J2V4|Fd>bG08(u4#?aCTUfwsl z{TWl42|bHA2xHp6o%d%^K-JUV6R+VEJtB_j^juRPb}G3*dpx1g1>G$4D|Q=s2G}3F z;M%u%O4iu*46HuCLsus<$^K?YHU&?^`|2hfnKp0+1Y(JBc(8|T9J{KMB=@c(b3ro2 zd}F1=?F9afZ~ia~4`SjA>gbccd%Z9QB@zWr+A5TT>sE|}xp#hA#&LC`+{fA1q~Mmx z+3>dUL=K{Nck=f3=8SQ@%l>15p%Xoytnks;MkrQJ`6T31H;fuO#pNAfE-KSZmMP3@ zdV?m2M1M4Ni5x`?cm$`5?d(F2Rn)Mc246oiYT~1vAZvcRa4>RjEnY z8NB%znB~)cz7NJ}j%6vQisQW~_;r>G41dCv^mugKaMV#j1*e|WaXQam%?@nx(d*kR z@V)Bo;iEq2(L+y3>yNCS^$`W~tUB=5o*d2ik0YLVGl&)hCY;~+g$9;+2nOIL&ClSa zTuN#y(f|?&^pdT#|Ez4cA^jTq_=Y?0|BCwVa5kW}eTrH&O080>)LunxYP43(*4|X@ zy@`aP_O8aBMb+LrYL6iH9yKCnjTi~R=Y7B5`2U<|Ki74x^W5h?g}(n)O**8@D0X7% zVv1o98ti#psHl7+4G@z!_b)r-6_a96mysLGA`sTw(Ba-7OH=r)+EA&MQ`L_4tX0x^ zh97RKX4$v-B12RoBIkh@0H=2|>nW{0opXR%ix!QX23G=kLL=*dp`Khm?uTVT%=5qU zl4gELxb+XDu+fPBS<+5c=0N?{hS8o(nA9d9b3JdK`8G~5DcxJQ00$!y=d99=`xY)w zp-=NHMv)Qjt9j(z87hEilFo(355}q1@Z61JoxzK+smK_6!asIS7%bE2S{&+M-m`xqaH!!UdGuQ{MHaAnI2l0j<#hiPzCyfQYWoGe0;pPvFm9 zT-J;f{>>*8e=-gaW$IrStoFN!%a~L;Qa~w)fv1KAARO8J#5#Sm8Z{j z#VBuH3O4+H@pkC~JCMTsw_Q%vgPKQz$H#I*U>;hwTpuL-h7cqpS2-lF(*F7RD~i67 zB&2SfG7B>msr15LAdW>s7Alqm5I~DQGk<7+a$^#JgrrLh9s~7$Xle9d(Mgo*vsD77 z{XEUQAQbTUUiSPIpf#1~#b0Qe-(P5Lc5fhIUulw)PBL~)2q*Ap5kw1*lb26_XnqN}@H)z34&U z?4Hgp4HD1g^PpCA;OR=)fDO?6y6cAq?_jC(#}EdCh`QU>IwX)KN;^qF`M~?}m)5JT zP`Yj~INK=K`7hKcie~x|80v(_XO498{ z%^s9ZU(A!qoHI=zrty!fwL9+QM|?owwFzMRf6~AS2FK|Vrouv>ZbLV&|7K8fNZY)u z_sZaM(dD5>N()A^cp|44v_qzt)7Vu!$_hUiHdi!+Gsi3aMT~4UHg=v|7Nr$)@50{9 z>sQQ{(kob4m;|9pD;r0~k%Nr~Vsm~KY04(B>;tCiYDmM}oAtAst`I3MB8-^1o2*4y zg=}#5@v$pYJIkkeVAjPefCS@EAtJ8tvw2n~bX5N#2M1`#1Ca#)q+jL=(#NqNRit|l zV;QlZ#8SMO5qsok2-sFZGbtrhPJ{>uIw=e`rw!G+gd*hp>*aCy>? zvFOe+_1UcHYR?BD$%7t)pjqZN4t<aVv#X#4^luROO`zvzKdla_cXG4rX=K-zCu|J>K`0jQkZn&>rh- z>q*zkKe)=0ROa|p#N4B4M6USBET+lU%s<_26PUl6swgZeP}E@(*;cNu1~k7XyBjLZ z`HpJ}_F3G%AAjI!fpx$zz!qTGfrip=ZgX!>06=%A<7x8awY>DVcI!75wXO&#Uzb9A zHpP!eJ}**?zDle*Ov-CgAC3N^=C%f#m_;69M2Pse-+jVicE?|p7pHyz$4(J<~(i=wYOGLEU<%oiQ19w`jb~5lv3X_mQZu-QAF5j zyURDVYTRjBr8W-84N##WY~6PKt5@Up{EN%>@?_At1##d*91dmXm79_9O;V`0J-&J- zpK)+*(;)3(T5-M#g*qaET^f{}zKnLz!3M-K{r>y{M~!|6dK$UU0{mKS1)jh089wp^ zYd{j+YOQw%d+yQ?e0FVr=dgLi!3zTw+BkM`_el7$gU;YJ$1KNg&gTayx7TlO%4d!M zt?uykNvryn@^{l4w$F`sbSjz%J*O15cln`|JisON88##nfPU9$(VI2@VJ)y4#^{%M z6js!13fnZP*!`ln;HMR^%EyNq@W#*DCvh1TYB6&#vZSlKwm19H~JQ6?WU;JO# z5kR7Ld^&MB&Ca1I>0t!MCA?GexWe&E#x3p=}c>M%Vwn0Sj)w5+(Zh1v781%P3 z*?dm@r{9L5rIzX@KJW$=;>v3tbcad25&#QagCiBE75^)48;W>{K&Dj_?+f*XXBZ!F zR_V>eQ`v_Q#P&x7ry?n1VXlqKT`eXnzX*Ztign-ZO&3fsm%QACV)MCjOiNwT=Rf@? zyE>F^p~Y9X(2UW~pQF3J5l>#Y@4~0|SZ<;CC`X;(%hUO7L*CnkziIFKcH-Xvw5TOh z`hM3OpEVQYrK*@}CPu^F?*}utYCbXE)Y)67QZjfd%Vop$A`N=Hdo30DIIr^(gHF1G zvq(BMeUX^Ne34-3H7~e>%PNPbHFdm}aWQ!^X#P(YL}d5S-T0_|l4n;p!5Gm?U+7fP z!jB{4W`p$yzKYNU-Cx{?4&c<=Xpg`J$C=E?Pll3-8jyKO;5-)-tLhVDbw&n{oQEfp zof$G!Uf&fSJbY-BLUn8LXFT7c=|_TU%MEA`XW4~ncv(2+JJ8ZUq^W_ev5BP!uL%Av z=w6fluf(qR<`3BpQd!vW)pW8Y%HvP2CAg_7n2!jK^-iTP%`tGDw?^{a6(7LAxz1Rv z3)Vtc$M>Et-r$@L&XwlS{{#* z%?2{~t{;8&ntME~&j1RJ1vVdO;f_^L8v1izz0`GA82%;8E0G;Q!Jbk=Rk*Q9ykP{9 zwvb)l!HhkuHYv7Ct~*nRc}1w4!c$`~1^wOja3=&Y)f{t1-=17-oH(8FS!4=SyXujR zcIH(75Xghz3@T(Jzoi37k;X zrbjpVDeqg4O?>>{{~ew0*i0`}sgF>o_H#p@!M32sD=a(I5fiV}V0=RFX)h@kwli7; z{v~k=mD0CJ@X^Ot(aifPRR8Z|g=rE&)N^HKn|fz(F`b91J~!2` zpdH(30GLb5bz4^RmU)Qg7O?xh9x>9j);4v{eWiVeBtoCjmo1|`ldGQ<_GkYnREV0? zsed4$`tejon3!}p!kRPMC4qh3`uXcD?cG!Wnq;f%-WdXr5n&=$7Hf3o7kgRFmrzTP za(2#kiBiBUD&q6^jT@>qc~U25YJpM&x~wo)d1K&e6S9=jH+B`JWUvQAqO;(17FZBK zcx^2vQ;a>m^3e;)2OBOjk*fw3<-QOGF4nJh-Fe7D@)QHwu-olV&mk**>sJ#6D_-mi z1iuSrns!P{xpKoTmeFUY_g+8@<#l$B09pU8vjyc5#dh9+T8)M76ckFg{#yX@SDV~_ z(eN_~_V>2%zB;6U?-2mK>NM_WQG4enWns>yR_=e-!J)2Xsl~^w{mOUq`;0#r6oN5}O5)y#~?c?S*h_@upl zQSy^#c-Szn|MpDkzu#dd+?fu+QO0NO2y=9U~R?6EJ(#tAM3y9Y}Pi`s}tCNwwa2 zq;(h27Sf=*EPTSC>bujBTN7ViPPcB#Ecj15jlExHvqY+ehUaeG>K1x~-ZQ!Nl=-kn zbP)|!kLykq(9nektRqYaa2aJ4Y+HX~@SiSv>0jRh`im5=!Js~^^?mSxJKTMHjY?v8 zVIE67<#Il@C2JLsypu8oPFN?4$Q&t=oadNY1q>5`q0I*^QX6R zD4HPWPxKb^tRKjS|8J1^U8ka6>G!fSg0%b(KS1{x<2i#afYzM<)w5L?N~eI>r8^bS zwB=5inr;qxZGSPSOpxdJUgs4XN6ekD1eco*;qL{MrcO!6N!%)#{81Sf_ZdZ0`s`&5J~>IzYFU(_%TMg&eCB69q)8it?8MkVAL;BV zxo%KgVZB&PE1{6*vo?tl;p6&BEidXAq~a!gR4^!UgbY4PvXoo}g@|oO-m(Et2NS!F zkxPjdsj0BVqIu_(Px80y`06F@sNN1iwwb6x_Vg18aeQURHJ&uTdSTCpvrO)&fEYq6 z3kicA_FqElr+57>tMvTaU`FZ;BtE3n-*3WeS*+rcB3msBs|q#%!*V=^&TH|tO#lug zbPPScgFy-h)yjm{HnbHr;gvzdYz}3F9Hr66nP~TxkIrmX8^Z`nJ)!Zys*x~i5yyiA zFG+l@ZEzN{bPSEKyJWqYPfKh0%D~e4Nnf9$+>x0>>jaPv0B}yxMjKK9dN#INB!6n$ z#~M#K9cC)sbjALErQN{AgfN~}r#G-nd^BSA!%)DPSJ#9DdyI8_|DY6uymG~$2jpi$ zQ>-1y;*M|Wxt4FZ0VYXZ%}P5%g)eAZQA2i3lr@%Rh9>Gi;cZ+?2|6M>ll z>J}}1wB{2?<>u6mTRIXu8b_BX{J-6><*dVT$eTBT8J{L&!+3C;BD1rvuYuhHF;8{8 zQ)^BjmNlgbTkeqPm6b2sPbI>@NHly0`qJ%m4~6m$k2 zIZ(#DZ)glNu@M>{^c+DeTglVV*KE3 zz`=sp7EzVg64RmB#$|Cuymg-H0)A)kf%y1%`aw98n5=6hg=p&P? z9q7RG#bI#wICqbtjv;#y(GF+nK1a}HbB-7tdu9GF$2Pgu_4T~DPkel(q8XK3CJq(1 zAC&RiyOk-5UhcMTr#5%4ji@2Unq*H7_EX#ugj1x}^sm_IViJ>6VtXUE;R+luu`SxS zid2!9y_hO<`fuf*arD<-?Ha_lOOseuPzM8$bU4?A*sC9cZMMek1n--73oL!8@)pjyO^GmWJ17DxbFwwZ?>PB5AxD)L!t0M6y6OJ=5Dsw^k3~)39Ki*1MN7*Gu^uS zcn2ap+}(4ZHAsif2>)KEH>p06lgOv6=0G_2N5}_XW_dM9l$k0lJwQQXB6!9yMal|@ zbXo@n?{+f2J1Zi(fb&EZvlPlPkN^fu8K=Oj}FISvK!kkR6w62xmiS0Lm;_ZMs)w*hs^uk@r zi!K5FkcuzOzxd}}b#6y?Y{2IK?54LDxNG%A1Hq!38nzu+3^^G z<9OWrZhVDE;@Z)L7>Oi}<6d6_9`57qhu@MG<&LdMm}#<#QEi@u&Rwx*`77q-=GEcA z5F^+3wRv~92WIm^XWqu4T34W-bOy5BHI>DC-7&le9XJIc-9a6loj73@iXV;nNy(qJ z_}?B;Rr^s#lI0NVq)>6Gt&Yoi$uQ7-F1?^sOvJTP^G;16O92yqCD%ml3T*6hMT^cD zRhluHrmM&l%HA}1HO(I6d}*G`{Da!T;rmwPC#YHqvN=t^<_i>b>q;Ga&Zq?e7X9hi z^?Kf3tyT`bv}nw;|Liab90mNtt3>fU=4x!t!~U%^>pt;8zx2nV9QVoSvRJMyNuDV4 zv5Vj@Ls|1FBE98xkWy@yx@M=zr+cT&=69&P=^Oe9ecMjl?YCGkkH3tAX6!->L<26a z-Kg!x>&h_wj#OmYG;#eU#N4-U&PK*y#A8;EmkrSyt!&*P^jcaJE-URVhK(k7!I#}7 zc=cQy|EzTJo#&*)%~(VeI)E)Fhz_~56ulIyB(s=2bG$Zhg}O%hcQ48ZpVFc$ty_g! z4u*znqi}Gr_df07jntKq-7VeVMQ z)(4M;)lp~vVqfa%Obd9n-rQ>an>tT`U`AzYOGZSDWm!PYkg=p9;0|orKEhTn=sgt0 zhEQj=P+%$H{P0mS#W^G^8rz;o_v)Z*!`XJw>E^K0rOCb_mN4MOJoyKdyMC7uIc9qs zcSVNQ;d+48Hzg}l)fE*^wjps=YV?!StX^Q@=F8I-e<4F+{+B)Oc60S=0(*9F(Hart!5pnRV_aE_nI zmVuGYkmwOX`_Pu(_Iy=PLlpa;@!Cpv8tCA_a?yVJ`_lSP840FezVboo0}!P7RvJ_R z%{uS@n$mvYl=vgv5%DPIfOfiRRw~*9b@9XND9E9zK|!HOJx+0-$jkGj_(bsap={g} zQgi#dC#hM3c>CmNhb(dN^QiHh$UML0pU2DRz+b5=D+ zsWOWdnM5vx4IeU1IiE;bL5t6G0A|xb+X}sS=8pMK%zk{f4%bmba?HMRt}ek7-rEj< z#fvb0@~Yr8mUaE@v77VUg8ua)b|$=-eH(N0^zd8^ZAeN-cw2_QKw=y(qF13Q6{n|f z|M!)oB>&Kr5_DKHr=^+*rB_gt7sZaMNyJ}&uajMfm8{TL@{0JBCfq;$D#C+yezLb; zd|T_|=f&VkKRy^BFvXaF=-a-5{Z`eS_5AaebP?Q=PG&*LD`(%8Pp%pH^}ee7-`+;_ zFL-A9o*_P$zCSMt-D2j$k$5#MG<@eFcOUf4^oNC|Q?dlH2houFlWYcmg=05|%bh7? zeM~}MtKI5_4Fr&Wj2)r15)|}*x_nSwq*UyI@@N`xST2oVpT5N!XHi{}D^t3LW z)QWYzln?}cv`F-@tpJ-bx;2s|w(^WsB^_*bQKh+#fV_AwFOu0j+L zhwf}0{96B>DmmoSin7%d_O_O{J?}3_-K{!xpZ7NQ_1O(piGa>BCsb~N8fz(%;B5`S z><96Y71j{(#eq3vk|K+edR73!{2M5dH}c1Qy|cIIhJzvK@RXPKN|HlJ7Jc}YZ)x@R z=6GiB+z>kK;_-@eC`_D*ELPO!BWtwUb{4TlSlBi^{-ZU3lRqhQOT4Oj1Jq$=W>0VM z+{dD6A_66!;&N;G?v>?NJnBa*+$P)Xf=(NM%N(uPBV1I>u+xMQdzMejPXd3a z9q)SU?37-g=>@v+(O*b`k6cy3-Gpik&WnP&pu)H1!R2pc?@srJhOS1qYmqM9$E}w4 z(b&5mLotm9<t93*u}%_?&I@<({Y~xI@y}YYbBk;1;BMyD z;^O|%)9HzryP2v{H^`S(=iy}m#Zv?v-Rx5NHb-kYv%5T}@YGaUER3yRC;>xehpD!es1gMDY)rLAZ4`DY_hw!C7jR>u(TKM-eB8GtSm3a zstZT$5maSzy-rWzwtu?^K)ymZW95bGe{|MtH1A7e^2Jj zh&aEAV%iw0dSO6u2A+JGRA_OB+bc^SPqbZ!3Txk_Z=2>rQN z=Vock1nN#SB$^R)M-Sle9ulB-9$_v3b(duYR-=9@OfkQ`+}vu!_ReUIg6erUr9` z7^=Hgn6q0LrwQ1a{$~BSfVntOrqCTWDg;%v-waLrPIGb1|1^KhHvi0K29+EG$LGB| zUTFD@uEmy}4Gw1v9*w+?J$S?KW>^EXx)N2+TC zhONu}Nda!+B~dT04W+#&CLTBJcxA6 zPcr?5?VaFqQp3@hM6^I-40PiJ{kS5$gGlOXz$JK?u_l-{sk z^&S$X))sE=9Q3;%q{FW@Czd1#hf#5VtC(ppQgOw7E`vkrTc^}|fQ-3!v_JhmiKM|HrA2=Bl&?)2e)`;lG^#ZViDV4_R$p6~Js? ztK4U6+^#q|xg*yn)6VP}v(xi9#8;AAr`&=Zn~=W#0?9ANmZ)LzXh=a~C+wtPXUDyM z6h@*TXZ5@<{^5>Hy!mSll$Etg)A9XMn_4$PVj>{!fBQm>(Uu>GWFg-A1U3%q- zIW{nU5#n6K@#^b}C`pGruWVi~g0^OSuGJqe-QckH;(U>ljsE?j&C@rLrKlj?dw~zF zSm$QbZSRUF!86E4BvL`}S%M4Jt+2-qE~L|xS~P;Wva@JQTSLutv&NZLtoo~^Vt0tb zmjFzeDM|3wz>BmVNP=3eCmeQOYTx*7sZ1kyw%Bu;z85%+ zq@9l@iwHik5aU-k`WKtEIk@&K@n2U<)!}T5MvHm-%|$QF;vQ0)G6^N?rpU-HIrwZR z;|I7qQ_QvKy}ZrK1%N&Zke^v|DL2$UYEX<&c;LkykuJR<52H7suV3J^j*J6JKh0PN z#Oy6qY&&6Fk5bo94sA$KmQvJsD9MwS`}qFif2tL-SS$0dpI?Zc(v;*oAHxCD4|MA- z4F(8{p5fONvZqT8@lF=nGL{2+4*D_s$B(k5}$UmeZ7|j zD(=(@Hiu`Ke7^e^)z#Ito@z{&pknX+4Hje$XR;()V40J6`k3|ScoU!Pabun5@9%mP zmE0H)8ujqF3@j`{ssH>D@QaMH5^8TCZ^LDO{!!%PNEn6MW7YyC+i#)^Ow8An7w4hu zJ@(nP%+vtDo!CBc0r?3jw%d0#ygUU24b7gQ#AL4HJ^wT?jFCKsgZ06I)s3?0qQi$N zB1!(9M3$G;5+Nl%L^iTl=&#ok5~E5*pOeBWrLW$koe8@$Zw6)W)1O4YY46?P5(SAV zQT%^;4ds0^Zq*?DWKH2F&`MIl^ zWEn%ensMHAjJ3`FI1qZl*{@K`N&MXJDJ!0e+qa*e+GM{4^Tk)bR+MV8-stG&VK7`i zKAqZPTO9O+%>d^;IPwo^(&- z+FY-X4}F7=lL%`%MHaXyLv>oz)~+?>bxYyv?uV!4Q$xcnTb0^<-wehR<%%U;Jo>Og9FXpA z7+m9CzO^|~+=lCrvnjn1kK-e#&g&3sd&NfXGTJ0kul{Ll{gzl81UqJ8_%IE*41!RmC`9Gbpt%HjA}7%@P?8(&foUCm1E*2&oP zA?!^}75N2RqeGh;addDgdKQg0I&z5<894GRqif|!!3NMzWJqa_F-WrD_LYmrp1Hn| z-7Lagf`8mNvVumy?6;R;ff`k9|FlT-ilx{F(5Q|&)E(*xCmJ>xaZjpw`2yF}9d;*_1R z_t7&i=K$3fV-{5>8-EF-Ja#@rS&T{rkI-8f{%WI`b)?cK3Er*wIuc1Bfos##&3)2p zP)wC7<6gKp`E7wy8J?h-et+SU-WxMo1qIc0l;u17=TaMHv%A&z!NcLz_iUq}^ALcRQGp zO3#doE5|#DE|A17N&RrT%=+<_Q}UAjR}>vMemq*pZZSq4keZc7wkj?Tyw0KDeUqAX zGZq}z9c5m3xA==aFv2W4<~sN*{{4?ULGuufMXW;sxyI+iSm?i7hO@%9UYV(+`Q>Nos%vF8g!Usd2P z;4~-_8`!v6@(tpz_4Q(RM26{pkU|)UyNr=ihw-ukPHw<UpU+AXw!RaEXpRZ`!! zYg8dc?5IoMJQ2hB>hz-+?AEJm77QYbCtHtF_p0^ms1x@`UMtAF;}i{5AxiVl9DDpj zl)*5)Ng<4^TDD4i$KlbhQ-E&f_bUF+KzD6OX^sBayL(UNNV{|$loE2{yD|2UlLV?J z@Ig(y`w&7yeCv-`?uUV^&4RXrHsy&k@i}adNm;XgZ!a@xnvjG)yI_LjRiUqV%gYIh zTK1D&S;x6J%jL!y86wNhlMbcxK=q;CDA?OTEGBAUdVZ$JYB=ElyA%2HUEC_MuhHw9 zfP)~1CR0x8cHDC6+A8>NSYxQ2z$vA2UJn>pzZdq@C^#Xoh zdqe|=^fm{HmPOP#EjbbH25nT$CZP%K7azkF(mG$3cnFnvV!sc|V%0fVJ$l8KpsRTu zO8L$dH*_-Z+K;9`{p&$Rca2+turcwk=8~cyK0rNk55^Im*gM#q=U-^i{<0)$3uHRn zH_J=aK6A*?VLE!3Hi&0;r$KN%3v1#-jxKH%pl+cXKmYXX5gm8@@y1#xCav0t9od(z z48bdZip}mIsrXig{8+&@W$YEwRGTr);Lw|2E0DvqPPPlK%Q*y-eRpGMtZQa*dHiOB zm&!{b3*PxxlCIhz1he8Qe_ituN*=VlqosmzZgl~c62oxde$5Fm7!q248t=D%7jc(T&EAIMN0uPq5-R!nvG8HJu)x# z2l7Bbq!k*ScO@_{>}1p$JUt%!O}$q309mlnN$TVTn`5E)<0cDkchxB5N9ij>^1C4R z#OSfF27Mj!AhRy0lnNE`7ddO(RS@~@s9$AV72Rat8_}SIGlyS`bO`b4OLVX-@+it2;l!x9Kc))(Q=DJL~4JFw^ z(QdVI!ny}MfWXZX+W7j09)ZfAZ3qAKqN*1(7zzgC2SM1%t1q&GJt^ZKz5~NjeW$5Z JrC|B>e*nH7H{}2T literal 0 HcmV?d00001 diff --git a/website/docs/tutorial-extras/manage-docs-versions.md b/website/docs/tutorial-extras/manage-docs-versions.md new file mode 100644 index 00000000000..ccda0b9076b --- /dev/null +++ b/website/docs/tutorial-extras/manage-docs-versions.md @@ -0,0 +1,55 @@ +--- +sidebar_position: 1 +--- + +# Manage Docs Versions + +Docusaurus can manage multiple versions of your docs. + +## Create a docs version + +Release a version 1.0 of your project: + +```bash +npm run docusaurus docs:version 1.0 +``` + +The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. + +Your docs now have 2 versions: + +- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs +- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** + +## Add a Version Dropdown + +To navigate seamlessly across versions, add a version dropdown. + +Modify the `docusaurus.config.js` file: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'docsVersionDropdown', + }, + // highlight-end + ], + }, + }, +}; +``` + +The docs version dropdown appears in your navbar: + +![Docs Version Dropdown](./img/docsVersionDropdown.png) + +## Update an existing version + +It is possible to edit versioned docs in their respective folder: + +- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` +- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/website/docs/tutorial-extras/translate-your-site.md b/website/docs/tutorial-extras/translate-your-site.md new file mode 100644 index 00000000000..b5a644abdf9 --- /dev/null +++ b/website/docs/tutorial-extras/translate-your-site.md @@ -0,0 +1,88 @@ +--- +sidebar_position: 2 +--- + +# Translate your site + +Let's translate `docs/intro.md` to French. + +## Configure i18n + +Modify `docusaurus.config.js` to add support for the `fr` locale: + +```js title="docusaurus.config.js" +export default { + i18n: { + defaultLocale: 'en', + locales: ['en', 'fr'], + }, +}; +``` + +## Translate a doc + +Copy the `docs/intro.md` file to the `i18n/fr` folder: + +```bash +mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ + +cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md +``` + +Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. + +## Start your localized site + +Start your site on the French locale: + +```bash +npm run start -- --locale fr +``` + +Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. + +:::caution + +In development, you can only use one locale at a time. + +::: + +## Add a Locale Dropdown + +To navigate seamlessly across languages, add a locale dropdown. + +Modify the `docusaurus.config.js` file: + +```js title="docusaurus.config.js" +export default { + themeConfig: { + navbar: { + items: [ + // highlight-start + { + type: 'localeDropdown', + }, + // highlight-end + ], + }, + }, +}; +``` + +The locale dropdown now appears in your navbar: + +![Locale Dropdown](./img/localeDropdown.png) + +## Build your localized site + +Build your site for a specific locale: + +```bash +npm run build -- --locale fr +``` + +Or build your site to include all the locales at once: + +```bash +npm run build +``` diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts new file mode 100644 index 00000000000..04de875a844 --- /dev/null +++ b/website/docusaurus.config.ts @@ -0,0 +1,123 @@ +import { themes as prismThemes } from 'prism-react-renderer'; +import type { Config } from '@docusaurus/types'; +import type * as Preset from '@docusaurus/preset-classic'; + +// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) + +const config: Config = { + title: 'Kubernetes JavaScript Client', + tagline: 'JavaScript client for Kubernetes', + favicon: 'img/favicon.ico', + + // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future + future: { + v4: true, // Improve compatibility with the upcoming Docusaurus v4 + }, + + // Set the production url of your site here + url: 'https://kubernetes-client.github.io', + // Set the // pathname under which your site is served + // For GitHub pages deployment, it is often '//' + baseUrl: '/javascript/', + + // GitHub pages deployment config. + // If you aren't using GitHub pages, you don't need these. + organizationName: 'kubernetes-client', // Usually your GitHub org/user name. + projectName: 'javascript', // Usually your repo name. + + onBrokenLinks: 'throw', + onBrokenAnchors: 'throw', + + // Even if you don't use internationalization, you can use this field to set + // useful metadata like html lang. For example, if your site is Chinese, you + // may want to replace "en" with "zh-Hans". + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + + presets: [ + [ + 'classic', + { + docs: { + sidebarPath: './sidebars.ts', + // Please change this to your repo. + // Remove this to remove the "edit this page" links. + editUrl: 'https://github.com/kubernetes-client/javascript/tree/main/website/', + }, + blog: false, + theme: { + customCss: './src/css/custom.css', + }, + } satisfies Preset.Options, + ], + ], + + themeConfig: { + // Replace with your project's social card + image: 'img/docusaurus-social-card.jpg', + colorMode: { + respectPrefersColorScheme: true, + }, + navbar: { + title: 'Kubernetes JavaScript Client', + logo: { + alt: 'Kubernetes Logo', + src: 'img/logo.svg', + }, + items: [ + { + type: 'docSidebar', + sidebarId: 'tutorialSidebar', + position: 'left', + label: 'Docs', + }, + { + label: 'API Reference', + position: 'left', + href: 'https://kubernetes-client.github.io/javascript/api/', + }, + { + type: 'docsVersionDropdown', + position: 'right', + }, + { + href: 'https://github.com/kubernetes-client/javascript', + label: 'GitHub', + position: 'right', + className: 'github-icon', + }, + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'Community', + items: [ + { + label: 'GitHub', + href: 'https://github.com/kubernetes-client/javascript', + }, + { + label: 'Issues', + href: 'https://github.com/kubernetes-client/javascript/issues', + }, + { + label: 'Slack', + href: 'https://kubernetes.slack.com', + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} Kubernetes Community. Built with Docusaurus.`, + }, + prism: { + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + }, + } satisfies Preset.ThemeConfig, +}; + +export default config; diff --git a/website/package-lock.json b/website/package-lock.json new file mode 100644 index 00000000000..70d8905de5f --- /dev/null +++ b/website/package-lock.json @@ -0,0 +1,18448 @@ +{ + "name": "website", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "website", + "version": "0.0.0", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "prism-react-renderer": "^2.3.0", + "react": "^19.0.0", + "react-dom": "^19.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", + "@docusaurus/types": "3.9.2", + "typescript": "~5.6.2" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@algolia/abtesting": { + "version": "1.16.0", + "resolved": "https://registry.npmjs.org/@algolia/abtesting/-/abtesting-1.16.0.tgz", + "integrity": "sha512-alHFZ68/i9qLC/muEB07VQ9r7cB8AvCcGX6dVQi2PNHhc/ZQRmmFAv8KK1ay4UiseGSFr7f0nXBKsZ/jRg7e4g==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/autocomplete-core": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-core/-/autocomplete-core-1.19.2.tgz", + "integrity": "sha512-mKv7RyuAzXvwmq+0XRK8HqZXt9iZ5Kkm2huLjgn5JoCPtDy+oh9yxUMfDDaVCw0oyzZ1isdJBc7l9nuCyyR7Nw==", + "license": "MIT", + "dependencies": { + "@algolia/autocomplete-plugin-algolia-insights": "1.19.2", + "@algolia/autocomplete-shared": "1.19.2" + } + }, + "node_modules/@algolia/autocomplete-plugin-algolia-insights": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.2.tgz", + "integrity": "sha512-TjxbcC/r4vwmnZaPwrHtkXNeqvlpdyR+oR9Wi2XyfORkiGkLTVhX2j+O9SaCCINbKoDfc+c2PB8NjfOnz7+oKg==", + "license": "MIT", + "dependencies": { + "@algolia/autocomplete-shared": "1.19.2" + }, + "peerDependencies": { + "search-insights": ">= 1 < 3" + } + }, + "node_modules/@algolia/autocomplete-shared": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.2.tgz", + "integrity": "sha512-jEazxZTVD2nLrC+wYlVHQgpBoBB5KPStrJxLzsIFl6Kqd1AlG9sIAGl39V5tECLpIQzB3Qa2T6ZPJ1ChkwMK/w==", + "license": "MIT", + "peerDependencies": { + "@algolia/client-search": ">= 4.9.1 < 6", + "algoliasearch": ">= 4.9.1 < 6" + } + }, + "node_modules/@algolia/client-abtesting": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-abtesting/-/client-abtesting-5.50.0.tgz", + "integrity": "sha512-mfgUdLQNxOAvCZUGzPQxjahEWEPuQkKlV0ZtGmePOa9ZxIQZlk31vRBNbM6ScU8jTH41SCYE77G/lCifDr1SVw==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-analytics": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-5.50.0.tgz", + "integrity": "sha512-5mjokeKYyPaP3Q8IYJEnutI+O4dW/Ixxx5IgsSxT04pCfGqPXxTOH311hTQxyNpcGGEOGrMv8n8Z+UMTPamioQ==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-common": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-common/-/client-common-5.50.0.tgz", + "integrity": "sha512-emtOvR6dl3rX3sBJXXbofMNHU1qMQqQSWu319RMrNL5BWoBqyiq7y0Zn6cjJm7aGHV/Qbf+KCCYeWNKEMPI3BQ==", + "license": "MIT", + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-insights": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-insights/-/client-insights-5.50.0.tgz", + "integrity": "sha512-IerGH2/hcj/6bwkpQg/HHRqmlGN1XwygQWythAk0gZFBrghs9danJaYuSS3ShzLSVoIVth4jY5GDPX9Lbw5cgg==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-personalization": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-5.50.0.tgz", + "integrity": "sha512-3idPJeXn5L0MmgP9jk9JJqblrQ/SguN93dNK9z9gfgyupBhHnJMOEjrRYcVgTIfvG13Y04wO+Q0FxE2Ut8PVbA==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-query-suggestions": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-query-suggestions/-/client-query-suggestions-5.50.0.tgz", + "integrity": "sha512-q7qRoWrQK1a8m5EFQEmPlo7+pg9mVQ8X5jsChtChERre0uS2pdYEDixBBl0ydBSGkdGbLUDufcACIhH/077E4g==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-search": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.50.0.tgz", + "integrity": "sha512-Jc360x4yqb3eEg4OY4KEIdGePBxZogivKI+OGIU8aLXgAYPTECvzeOBc90312yHA1hr3AeRlAFl0rIc8lQaIrQ==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/events": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@algolia/events/-/events-4.0.1.tgz", + "integrity": "sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ==", + "license": "MIT" + }, + "node_modules/@algolia/ingestion": { + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/@algolia/ingestion/-/ingestion-1.50.0.tgz", + "integrity": "sha512-OS3/Viao+NPpyBbEY3tf6hLewppG+UclD+9i0ju56mq2DrdMJFCkEky6Sk9S5VPcbLzxzg3BqBX6u9Q35w19aQ==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/monitoring": { + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/@algolia/monitoring/-/monitoring-1.50.0.tgz", + "integrity": "sha512-/znwgSiGufpbJVIoDmeQaHtTq+OMdDawFRbMSJVv+12n79hW+qdQXS8/Uu3BD3yn0BzgVFJEvrsHrCsInZKdhw==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/recommend": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/recommend/-/recommend-5.50.0.tgz", + "integrity": "sha512-dHjUfu4jfjdQiKDpCpAnM7LP5yfG0oNShtfpF5rMCel6/4HIoqJ4DC4h5GKDzgrvJYtgAhblo0AYBmOM00T+lQ==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/requester-browser-xhr": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.50.0.tgz", + "integrity": "sha512-bffIbUljAWnh/Ctu5uScORajuUavqmZ0ACYd1fQQeSSYA9NNN83ynO26pSc2dZRXpSK0fkc1//qSSFXMKGu+aw==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/requester-fetch": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-fetch/-/requester-fetch-5.50.0.tgz", + "integrity": "sha512-y0EwNvPGvkM+yTAqqO6Gpt9wVGm3CLDtpLvNEiB3VGvN3WzfkjZGtLUsG/ru2kVJIIU7QcV0puuYgEpBeFxcJg==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/requester-node-http": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-5.50.0.tgz", + "integrity": "sha512-xpwefe4fCOWnZgXCbkGpqQY6jgBSCf2hmgnySbyzZIccrv3SoashHKGPE4x6vVG+gdHrGciMTAcDo9HOZwH22Q==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.28.5", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/compat-data": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.0.tgz", + "integrity": "sha512-T1NCJqT/j9+cn8fvkt7jtwbLBfLC/1y1c7NtCeXFRgzGTsafi68MRv8yzkYSapBnFA6L3U2VSc02ciDzoAJhJg==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", + "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helpers": "^7.28.6", + "@babel/parser": "^7.29.0", + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.29.0", + "@babel/types": "^7.29.0", + "@jridgewell/remapping": "^2.3.5", + "convert-source-map": "^2.0.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/core/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/generator": { + "version": "7.29.1", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.1.tgz", + "integrity": "sha512-qsaF+9Qcm2Qv8SRIMMscAvG4O3lJ0F1GuMo5HR/Bp02LopNgnZBC/EkbevHFeGs4ls/oPz9v+Bsmzbkbe+0dUw==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.29.0", + "@babel/types": "^7.29.0", + "@jridgewell/gen-mapping": "^0.3.12", + "@jridgewell/trace-mapping": "^0.3.28", + "jsesc": "^3.0.2" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-annotate-as-pure": { + "version": "7.27.3", + "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz", + "integrity": "sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.27.3" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz", + "integrity": "sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA==", + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.28.6", + "@babel/helper-validator-option": "^7.27.1", + "browserslist": "^4.24.0", + "lru-cache": "^5.1.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-create-class-features-plugin": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.6.tgz", + "integrity": "sha512-dTOdvsjnG3xNT9Y0AUg1wAl38y+4Rl4sf9caSQZOXdNqVn+H+HbbJ4IyyHaIqNR6SW9oJpA/RuRjsjCw2IdIow==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-member-expression-to-functions": "^7.28.5", + "@babel/helper-optimise-call-expression": "^7.27.1", + "@babel/helper-replace-supers": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", + "@babel/traverse": "^7.28.6", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-class-features-plugin/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.28.5.tgz", + "integrity": "sha512-N1EhvLtHzOvj7QQOUCCS3NrPJP8c5W6ZXCHDn7Yialuy1iu4r5EmIYkXlKNqT99Ciw+W0mDqWoR6HWMZlFP3hw==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "regexpu-core": "^6.3.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-define-polyfill-provider": { + "version": "0.6.8", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.8.tgz", + "integrity": "sha512-47UwBLPpQi1NoWzLuHNjRoHlYXMwIJoBf7MFou6viC/sIHWYygpvr0B6IAyh5sBdA2nr2LPIRww8lfaUVQINBA==", + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "debug": "^4.4.3", + "lodash.debounce": "^4.0.8", + "resolve": "^1.22.11" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/helper-globals": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", + "integrity": "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-member-expression-to-functions": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.28.5.tgz", + "integrity": "sha512-cwM7SBRZcPCLgl8a7cY0soT1SptSzAlMH39vwiRpOQkJlh53r5hdHwLSCZpQdVLT39sZt+CRpNwYG4Y2v77atg==", + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.28.5", + "@babel/types": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz", + "integrity": "sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw==", + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz", + "integrity": "sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-optimise-call-expression": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz", + "integrity": "sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.28.6.tgz", + "integrity": "sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-remap-async-to-generator": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz", + "integrity": "sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.1", + "@babel/helper-wrap-function": "^7.27.1", + "@babel/traverse": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-replace-supers": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.28.6.tgz", + "integrity": "sha512-mq8e+laIk94/yFec3DxSjCRD2Z0TAjhVbEJY3UQrlwVo15Lmt7C2wAUbK4bjnTs4APkwsYLTahXRraQXhb1WCg==", + "license": "MIT", + "dependencies": { + "@babel/helper-member-expression-to-functions": "^7.28.5", + "@babel/helper-optimise-call-expression": "^7.27.1", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-skip-transparent-expression-wrappers": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz", + "integrity": "sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg==", + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.27.1", + "@babel/types": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", + "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", + "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-wrap-function": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.28.6.tgz", + "integrity": "sha512-z+PwLziMNBeSQJonizz2AGnndLsP2DeGHIxDAn+wdHOGuo4Fo1x1HBPPXeE9TAOPHNNWQKCSlA2VZyYyyibDnQ==", + "license": "MIT", + "dependencies": { + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.29.2.tgz", + "integrity": "sha512-HoGuUs4sCZNezVEKdVcwqmZN8GoHirLUcLaYVNBK2J0DadGtdcqgr3BCbvH8+XUo4NGjNl3VOtSjEKNzqfFgKw==", + "license": "MIT", + "dependencies": { + "@babel/template": "^7.28.6", + "@babel/types": "^7.29.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.2.tgz", + "integrity": "sha512-4GgRzy/+fsBa72/RZVJmGKPmZu9Byn8o4MoLpmNe1m8ZfYnz5emHLQz3U4gLud6Zwl0RZIcgiLD7Uq7ySFuDLA==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.29.0" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.28.5.tgz", + "integrity": "sha512-87GDMS3tsmMSi/3bWOte1UblL+YUTFMV8SZPZ2eSEL17s74Cw/l63rR6NmGVKMYW2GYi85nE+/d6Hw5N0bEk2Q==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/traverse": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-safari-class-field-initializer-scope": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz", + "integrity": "sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz", + "integrity": "sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz", + "integrity": "sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", + "@babel/plugin-transform-optional-chaining": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.13.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.6.tgz", + "integrity": "sha512-a0aBScVTlNaiUe35UtfxAN7A/tehvvG4/ByO6+46VPKTRSlfnAFsgKy0FUh+qAkQrDTmhDkT+IBOKlOoMUxQ0g==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-proposal-private-property-in-object": { + "version": "7.21.0-placeholder-for-preset-env.2", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", + "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-dynamic-import": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz", + "integrity": "sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-assertions": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.28.6.tgz", + "integrity": "sha512-pSJUpFHdx9z5nqTSirOCMtYVP2wFgoWhP0p3g8ONK/4IHhLIBd0B9NYqAvIUAhq+OkhO4VM1tENCt0cjlsNShw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-attributes": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.28.6.tgz", + "integrity": "sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-jsx": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.28.6.tgz", + "integrity": "sha512-wgEmr06G6sIpqr8YDwA2dSRTE3bJ+V0IfpzfSY3Lfgd7YWOaAdlykvJi13ZKBt8cZHfgH1IXN+CL656W3uUa4w==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-typescript": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.28.6.tgz", + "integrity": "sha512-+nDNmQye7nlnuuHDboPbGm00Vqg3oO8niRRL27/4LYHUsHYh0zJ1xWOz0uRwNFmM1Avzk8wZbc6rdiYhomzv/A==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-unicode-sets-regex": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", + "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.18.6", + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-arrow-functions": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz", + "integrity": "sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-generator-functions": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.29.0.tgz", + "integrity": "sha512-va0VdWro4zlBr2JsXC+ofCPB2iG12wPtVGTWFx2WLDOM3nYQZZIGP82qku2eW/JR83sD+k2k+CsNtyEbUqhU6w==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-remap-async-to-generator": "^7.27.1", + "@babel/traverse": "^7.29.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-to-generator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.28.6.tgz", + "integrity": "sha512-ilTRcmbuXjsMmcZ3HASTe4caH5Tpo93PkTxF9oG2VZsSWsahydmcEHhix9Ik122RcTnZnUzPbmux4wh1swfv7g==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-remap-async-to-generator": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoped-functions": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz", + "integrity": "sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoping": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.6.tgz", + "integrity": "sha512-tt/7wOtBmwHPNMPu7ax4pdPz6shjFrmHDghvNC+FG9Qvj7D6mJcoRQIF5dy4njmxR941l6rgtvfSB2zX3VlUIw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-properties": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.28.6.tgz", + "integrity": "sha512-dY2wS3I2G7D697VHndN91TJr8/AAfXQNt5ynCTI/MpxMsSzHp+52uNivYT5wCPax3whc47DR8Ba7cmlQMg24bw==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-static-block": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.6.tgz", + "integrity": "sha512-rfQ++ghVwTWTqQ7w8qyDxL1XGihjBss4CmTgGRCTAC9RIbhVpyp4fOeZtta0Lbf+dTNIVJer6ych2ibHwkZqsQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0" + } + }, + "node_modules/@babel/plugin-transform-classes": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.6.tgz", + "integrity": "sha512-EF5KONAqC5zAqT783iMGuM2ZtmEBy+mJMOKl2BCvPZ2lVrwvXnB6o+OBWCS+CoeCCpVRF2sA2RBKUxvT8tQT5Q==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-globals": "^7.28.0", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-replace-supers": "^7.28.6", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-computed-properties": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.28.6.tgz", + "integrity": "sha512-bcc3k0ijhHbc2lEfpFHgx7eYw9KNXqOerKWfzbxEHUGKnS3sz9C4CNL9OiFN1297bDNfUiSO7DaLzbvHQQQ1BQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/template": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-destructuring": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.5.tgz", + "integrity": "sha512-Kl9Bc6D0zTUcFUvkNuQh4eGXPKKNDOJQXVyyM4ZAQPMveniJdxi8XMJwLo+xSoW3MIq81bD33lcUe9kZpl0MCw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/traverse": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-dotall-regex": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.28.6.tgz", + "integrity": "sha512-SljjowuNKB7q5Oayv4FoPzeB74g3QgLt8IVJw9ADvWy3QnUb/01aw8I4AVv8wYnPvQz2GDDZ/g3GhcNyDBI4Bg==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-duplicate-keys": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz", + "integrity": "sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-duplicate-named-capturing-groups-regex": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.29.0.tgz", + "integrity": "sha512-zBPcW2lFGxdiD8PUnPwJjag2J9otbcLQzvbiOzDxpYXyCuYX9agOwMPGn1prVH0a4qzhCKu24rlH4c1f7yA8rw==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-dynamic-import": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz", + "integrity": "sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-explicit-resource-management": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.6.tgz", + "integrity": "sha512-Iao5Konzx2b6g7EPqTy40UZbcdXE126tTxVFr/nAIj+WItNxjKSYTEw3RC+A2/ZetmdJsgueL1KhaMCQHkLPIg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-exponentiation-operator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.28.6.tgz", + "integrity": "sha512-WitabqiGjV/vJ0aPOLSFfNY1u9U3R7W36B03r5I2KoNix+a3sOhJ3pKFB3R5It9/UiK78NiO0KE9P21cMhlPkw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-export-namespace-from": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz", + "integrity": "sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-for-of": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz", + "integrity": "sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-function-name": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz", + "integrity": "sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/traverse": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-json-strings": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.28.6.tgz", + "integrity": "sha512-Nr+hEN+0geQkzhbdgQVPoqr47lZbm+5fCUmO70722xJZd0Mvb59+33QLImGj6F+DkK3xgDi1YVysP8whD6FQAw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-literals": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz", + "integrity": "sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-logical-assignment-operators": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.28.6.tgz", + "integrity": "sha512-+anKKair6gpi8VsM/95kmomGNMD0eLz1NQ8+Pfw5sAwWH9fGYXT50E55ZpV0pHUHWf6IUTWPM+f/7AAff+wr9A==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-member-expression-literals": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz", + "integrity": "sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-amd": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz", + "integrity": "sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-commonjs": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.28.6.tgz", + "integrity": "sha512-jppVbf8IV9iWWwWTQIxJMAJCWBuuKx71475wHwYytrRGQ2CWiDvYlADQno3tcYpS/T2UUWFQp3nVtYfK/YBQrA==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-systemjs": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.29.0.tgz", + "integrity": "sha512-PrujnVFbOdUpw4UHiVwKvKRLMMic8+eC0CuNlxjsyZUiBjhFdPsewdXCkveh2KqBA9/waD0W1b4hXSOBQJezpQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.29.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-umd": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz", + "integrity": "sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.29.0.tgz", + "integrity": "sha512-1CZQA5KNAD6ZYQLPw7oi5ewtDNxH/2vuCh+6SmvgDfhumForvs8a1o9n0UrEoBD8HU4djO2yWngTQlXl1NDVEQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-new-target": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz", + "integrity": "sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.28.6.tgz", + "integrity": "sha512-3wKbRgmzYbw24mDJXT7N+ADXw8BC/imU9yo9c9X9NKaLF1fW+e5H1U5QjMUBe4Qo4Ox/o++IyUkl1sVCLgevKg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-numeric-separator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.28.6.tgz", + "integrity": "sha512-SJR8hPynj8outz+SlStQSwvziMN4+Bq99it4tMIf5/Caq+3iOc0JtKyse8puvyXkk3eFRIA5ID/XfunGgO5i6w==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-rest-spread": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.6.tgz", + "integrity": "sha512-5rh+JR4JBC4pGkXLAcYdLHZjXudVxWMXbB6u6+E9lRL5TrGVbHt1TjxGbZ8CkmYw9zjkB7jutzOROArsqtncEA==", + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5", + "@babel/plugin-transform-parameters": "^7.27.7", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-super": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz", + "integrity": "sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-replace-supers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-catch-binding": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.28.6.tgz", + "integrity": "sha512-R8ja/Pyrv0OGAvAXQhSTmWyPJPml+0TMqXlO5w+AsMEiwb2fg3WkOvob7UxFSL3OIttFSGSRFKQsOhJ/X6HQdQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-chaining": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.28.6.tgz", + "integrity": "sha512-A4zobikRGJTsX9uqVFdafzGkqD30t26ck2LmOzAuLL8b2x6k3TIqRiT2xVvA9fNmFeTX484VpsdgmKNA0bS23w==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-parameters": { + "version": "7.27.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz", + "integrity": "sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-methods": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.28.6.tgz", + "integrity": "sha512-piiuapX9CRv7+0st8lmuUlRSmX6mBcVeNQ1b4AYzJxfCMuBfB0vBXDiGSmm03pKJw1v6cZ8KSeM+oUnM6yAExg==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-property-in-object": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.28.6.tgz", + "integrity": "sha512-b97jvNSOb5+ehyQmBpmhOCiUC5oVK4PMnpRvO7+ymFBoqYjeDHIU9jnrNUuwHOiL9RpGDoKBpSViarV+BU+eVA==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-property-literals": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz", + "integrity": "sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-constant-elements": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.27.1.tgz", + "integrity": "sha512-edoidOjl/ZxvYo4lSBOQGDSyToYVkTAwyVoa2tkuYTSmjrB1+uAedoL5iROVLXkxH+vRgA7uP4tMg2pUJpZ3Ug==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-display-name": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.28.0.tgz", + "integrity": "sha512-D6Eujc2zMxKjfa4Zxl4GHMsmhKKZ9VpcqIchJLvwTxad9zWIYulwYItBovpDOoNLISpcZSXoDJ5gaGbQUDqViA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.28.6.tgz", + "integrity": "sha512-61bxqhiRfAACulXSLd/GxqmAedUSrRZIu/cbaT18T1CetkTmtDN15it7i80ru4DVqRK1WMxQhXs+Lf9kajm5Ow==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-syntax-jsx": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx-development": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-development/-/plugin-transform-react-jsx-development-7.27.1.tgz", + "integrity": "sha512-ykDdF5yI4f1WrAolLqeF3hmYU12j9ntLQl/AOG1HAS21jxyg1Q0/J/tpREuYLfatGdGmXp/3yS0ZA76kOlVq9Q==", + "license": "MIT", + "dependencies": { + "@babel/plugin-transform-react-jsx": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-pure-annotations": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.27.1.tgz", + "integrity": "sha512-JfuinvDOsD9FVMTHpzA/pBLisxpv1aSf+OIV8lgH3MuWrks19R27e6a6DipIg4aX1Zm9Wpb04p8wljfKrVSnPA==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-regenerator": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.29.0.tgz", + "integrity": "sha512-FijqlqMA7DmRdg/aINBSs04y8XNTYw/lr1gJ2WsmBnnaNw1iS43EPkJW+zK7z65auG3AWRFXWj+NcTQwYptUog==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-regexp-modifiers": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.28.6.tgz", + "integrity": "sha512-QGWAepm9qxpaIs7UM9FvUSnCGlb8Ua1RhyM4/veAxLwt3gMat/LSGrZixyuj4I6+Kn9iwvqCyPTtbdxanYoWYg==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-reserved-words": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz", + "integrity": "sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.29.0.tgz", + "integrity": "sha512-jlaRT5dJtMaMCV6fAuLbsQMSwz/QkvaHOHOSXRitGGwSpR1blCY4KUKoyP2tYO8vJcqYe8cEj96cqSztv3uF9w==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "babel-plugin-polyfill-corejs2": "^0.4.14", + "babel-plugin-polyfill-corejs3": "^0.13.0", + "babel-plugin-polyfill-regenerator": "^0.6.5", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/plugin-transform-shorthand-properties": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz", + "integrity": "sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-spread": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.28.6.tgz", + "integrity": "sha512-9U4QObUC0FtJl05AsUcodau/RWDytrU6uKgkxu09mLR9HLDAtUMoPuuskm5huQsoktmsYpI+bGmq+iapDcriKA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-sticky-regex": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz", + "integrity": "sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-template-literals": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz", + "integrity": "sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typeof-symbol": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz", + "integrity": "sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typescript": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.28.6.tgz", + "integrity": "sha512-0YWL2RFxOqEm9Efk5PvreamxPME8OyY0wM5wh5lHjF+VtVhdneCWGzZeSqzOfiobVqQaNCd2z0tQvnI9DaPWPw==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", + "@babel/plugin-syntax-typescript": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-escapes": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz", + "integrity": "sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-property-regex": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.28.6.tgz", + "integrity": "sha512-4Wlbdl/sIZjzi/8St0evF0gEZrgOswVO6aOzqxh1kDZOl9WmLrHq2HtGhnOJZmHZYKP8WZ1MDLCt5DAWwRo57A==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-regex": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz", + "integrity": "sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-sets-regex": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.28.6.tgz", + "integrity": "sha512-/wHc/paTUmsDYN7SZkpWxogTOBNnlx7nBQYfy6JJlCT7G3mVhltk3e++N7zV0XfgGsrqBxd4rJQt9H16I21Y1Q==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/preset-env": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.29.2.tgz", + "integrity": "sha512-DYD23veRYGvBFhcTY1iUvJnDNpuqNd/BzBwCvzOTKUnJjKg5kpUBh3/u9585Agdkgj+QuygG7jLfOPWMa2KVNw==", + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.29.0", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-validator-option": "^7.27.1", + "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", + "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.6", + "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", + "@babel/plugin-syntax-import-assertions": "^7.28.6", + "@babel/plugin-syntax-import-attributes": "^7.28.6", + "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", + "@babel/plugin-transform-arrow-functions": "^7.27.1", + "@babel/plugin-transform-async-generator-functions": "^7.29.0", + "@babel/plugin-transform-async-to-generator": "^7.28.6", + "@babel/plugin-transform-block-scoped-functions": "^7.27.1", + "@babel/plugin-transform-block-scoping": "^7.28.6", + "@babel/plugin-transform-class-properties": "^7.28.6", + "@babel/plugin-transform-class-static-block": "^7.28.6", + "@babel/plugin-transform-classes": "^7.28.6", + "@babel/plugin-transform-computed-properties": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5", + "@babel/plugin-transform-dotall-regex": "^7.28.6", + "@babel/plugin-transform-duplicate-keys": "^7.27.1", + "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.29.0", + "@babel/plugin-transform-dynamic-import": "^7.27.1", + "@babel/plugin-transform-explicit-resource-management": "^7.28.6", + "@babel/plugin-transform-exponentiation-operator": "^7.28.6", + "@babel/plugin-transform-export-namespace-from": "^7.27.1", + "@babel/plugin-transform-for-of": "^7.27.1", + "@babel/plugin-transform-function-name": "^7.27.1", + "@babel/plugin-transform-json-strings": "^7.28.6", + "@babel/plugin-transform-literals": "^7.27.1", + "@babel/plugin-transform-logical-assignment-operators": "^7.28.6", + "@babel/plugin-transform-member-expression-literals": "^7.27.1", + "@babel/plugin-transform-modules-amd": "^7.27.1", + "@babel/plugin-transform-modules-commonjs": "^7.28.6", + "@babel/plugin-transform-modules-systemjs": "^7.29.0", + "@babel/plugin-transform-modules-umd": "^7.27.1", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.29.0", + "@babel/plugin-transform-new-target": "^7.27.1", + "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6", + "@babel/plugin-transform-numeric-separator": "^7.28.6", + "@babel/plugin-transform-object-rest-spread": "^7.28.6", + "@babel/plugin-transform-object-super": "^7.27.1", + "@babel/plugin-transform-optional-catch-binding": "^7.28.6", + "@babel/plugin-transform-optional-chaining": "^7.28.6", + "@babel/plugin-transform-parameters": "^7.27.7", + "@babel/plugin-transform-private-methods": "^7.28.6", + "@babel/plugin-transform-private-property-in-object": "^7.28.6", + "@babel/plugin-transform-property-literals": "^7.27.1", + "@babel/plugin-transform-regenerator": "^7.29.0", + "@babel/plugin-transform-regexp-modifiers": "^7.28.6", + "@babel/plugin-transform-reserved-words": "^7.27.1", + "@babel/plugin-transform-shorthand-properties": "^7.27.1", + "@babel/plugin-transform-spread": "^7.28.6", + "@babel/plugin-transform-sticky-regex": "^7.27.1", + "@babel/plugin-transform-template-literals": "^7.27.1", + "@babel/plugin-transform-typeof-symbol": "^7.27.1", + "@babel/plugin-transform-unicode-escapes": "^7.27.1", + "@babel/plugin-transform-unicode-property-regex": "^7.28.6", + "@babel/plugin-transform-unicode-regex": "^7.27.1", + "@babel/plugin-transform-unicode-sets-regex": "^7.28.6", + "@babel/preset-modules": "0.1.6-no-external-plugins", + "babel-plugin-polyfill-corejs2": "^0.4.15", + "babel-plugin-polyfill-corejs3": "^0.14.0", + "babel-plugin-polyfill-regenerator": "^0.6.6", + "core-js-compat": "^3.48.0", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-env/node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.14.2.tgz", + "integrity": "sha512-coWpDLJ410R781Npmn/SIBZEsAetR4xVi0SxLMXPaMO4lSf1MwnkGYMtkFxew0Dn8B3/CpbpYxN0JCgg8mn67g==", + "license": "MIT", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.8", + "core-js-compat": "^3.48.0" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/preset-env/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/preset-modules": { + "version": "0.1.6-no-external-plugins", + "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", + "integrity": "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@babel/types": "^7.4.4", + "esutils": "^2.0.2" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/preset-react": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.28.5.tgz", + "integrity": "sha512-Z3J8vhRq7CeLjdC58jLv4lnZ5RKFUJWqH5emvxmv9Hv3BD1T9R/Im713R4MTKwvFaV74ejZ3sM01LyEKk4ugNQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-validator-option": "^7.27.1", + "@babel/plugin-transform-react-display-name": "^7.28.0", + "@babel/plugin-transform-react-jsx": "^7.27.1", + "@babel/plugin-transform-react-jsx-development": "^7.27.1", + "@babel/plugin-transform-react-pure-annotations": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-typescript": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.28.5.tgz", + "integrity": "sha512-+bQy5WOI2V6LJZpPVxY+yp66XdZ2yifu0Mc1aP5CQKgjn4QM5IN2i5fAZ4xKop47pr8rpVhiAeu+nDQa12C8+g==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-validator-option": "^7.27.1", + "@babel/plugin-syntax-jsx": "^7.27.1", + "@babel/plugin-transform-modules-commonjs": "^7.27.1", + "@babel/plugin-transform-typescript": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.29.2.tgz", + "integrity": "sha512-JiDShH45zKHWyGe4ZNVRrCjBz8Nh9TMmZG1kh4QTK8hCBTWBi8Da+i7s1fJw7/lYpM4ccepSNfqzZ/QvABBi5g==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/runtime-corejs3": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.29.2.tgz", + "integrity": "sha512-Lc94FOD5+0aXhdb0Tdg3RUtqT6yWbI/BbFWvlaSJ3gAb9Ks+99nHRDKADVqC37er4eCB0fHyWT+y+K3QOvJKbw==", + "license": "MIT", + "dependencies": { + "core-js-pure": "^3.48.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/template": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.28.6.tgz", + "integrity": "sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.28.6", + "@babel/parser": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.0.tgz", + "integrity": "sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", + "@babel/helper-globals": "^7.28.0", + "@babel/parser": "^7.29.0", + "@babel/template": "^7.28.6", + "@babel/types": "^7.29.0", + "debug": "^4.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", + "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.27.1", + "@babel/helper-validator-identifier": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@colors/colors": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", + "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", + "license": "MIT", + "optional": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@csstools/cascade-layer-name-parser": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz", + "integrity": "sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/media-query-list-parser": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz", + "integrity": "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-alpha-function": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-alpha-function/-/postcss-alpha-function-1.0.1.tgz", + "integrity": "sha512-isfLLwksH3yHkFXfCI2Gcaqg7wGGHZZwunoJzEZk0yKYIokgre6hYVFibKL3SYAoR1kBXova8LB+JoO5vZzi9w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-cascade-layers": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz", + "integrity": "sha512-nWBE08nhO8uWl6kSAeCx4im7QfVko3zLrtgWZY4/bP87zrSPpSyN/3W3TDqz1jJuH+kbKOHXg5rJnK+ZVYcFFg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/selector-specificity": "^5.0.0", + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-cascade-layers/node_modules/@csstools/selector-specificity": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", + "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/@csstools/postcss-cascade-layers/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@csstools/postcss-color-function": { + "version": "4.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-color-function/-/postcss-color-function-4.0.12.tgz", + "integrity": "sha512-yx3cljQKRaSBc2hfh8rMZFZzChaFgwmO2JfFgFr1vMcF3C/uyy5I4RFIBOIWGq1D+XbKCG789CGkG6zzkLpagA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-color-function-display-p3-linear": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-color-function-display-p3-linear/-/postcss-color-function-display-p3-linear-1.0.1.tgz", + "integrity": "sha512-E5qusdzhlmO1TztYzDIi8XPdPoYOjoTY6HBYBCYSj+Gn4gQRBlvjgPQXzfzuPQqt8EhkC/SzPKObg4Mbn8/xMg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-color-mix-function": { + "version": "3.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.12.tgz", + "integrity": "sha512-4STERZfCP5Jcs13P1U5pTvI9SkgLgfMUMhdXW8IlJWkzOOOqhZIjcNhWtNJZes2nkBDsIKJ0CJtFtuaZ00moag==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-color-mix-variadic-function-arguments": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.2.tgz", + "integrity": "sha512-rM67Gp9lRAkTo+X31DUqMEq+iK+EFqsidfecmhrteErxJZb6tUoJBVQca1Vn1GpDql1s1rD1pKcuYzMsg7Z1KQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-content-alt-text": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.8.tgz", + "integrity": "sha512-9SfEW9QCxEpTlNMnpSqFaHyzsiRpZ5J5+KqCu1u5/eEJAWsMhzT40qf0FIbeeglEvrGRMdDzAxMIz3wqoGSb+Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-contrast-color-function": { + "version": "2.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-contrast-color-function/-/postcss-contrast-color-function-2.0.12.tgz", + "integrity": "sha512-YbwWckjK3qwKjeYz/CijgcS7WDUCtKTd8ShLztm3/i5dhh4NaqzsbYnhm4bjrpFpnLZ31jVcbK8YL77z3GBPzA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-exponential-functions": { + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz", + "integrity": "sha512-abg2W/PI3HXwS/CZshSa79kNWNZHdJPMBXeZNyPQFbbj8sKO3jXxOt/wF7juJVjyDTc6JrvaUZYFcSBZBhaxjw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-font-format-keywords": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-font-format-keywords/-/postcss-font-format-keywords-4.0.0.tgz", + "integrity": "sha512-usBzw9aCRDvchpok6C+4TXC57btc4bJtmKQWOHQxOVKen1ZfVqBUuCZ/wuqdX5GHsD0NRSr9XTP+5ID1ZZQBXw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-gamut-mapping": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.11.tgz", + "integrity": "sha512-fCpCUgZNE2piVJKC76zFsgVW1apF6dpYsqGyH8SIeCcM4pTEsRTWTLCaJIMKFEundsCKwY1rwfhtrio04RJ4Dw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-gradients-interpolation-method": { + "version": "5.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.12.tgz", + "integrity": "sha512-jugzjwkUY0wtNrZlFeyXzimUL3hN4xMvoPnIXxoZqxDvjZRiSh+itgHcVUWzJ2VwD/VAMEgCLvtaJHX+4Vj3Ow==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-hwb-function": { + "version": "4.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.12.tgz", + "integrity": "sha512-mL/+88Z53KrE4JdePYFJAQWFrcADEqsLprExCM04GDNgHIztwFzj0Mbhd/yxMBngq0NIlz58VVxjt5abNs1VhA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-ic-unit": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.4.tgz", + "integrity": "sha512-yQ4VmossuOAql65sCPppVO1yfb7hDscf4GseF0VCA/DTDaBc0Wtf8MTqVPfjGYlT5+2buokG0Gp7y0atYZpwjg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-initial": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-initial/-/postcss-initial-2.0.1.tgz", + "integrity": "sha512-L1wLVMSAZ4wovznquK0xmC7QSctzO4D0Is590bxpGqhqjboLXYA16dWZpfwImkdOgACdQ9PqXsuRroW6qPlEsg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-is-pseudo-class": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.3.tgz", + "integrity": "sha512-jS/TY4SpG4gszAtIg7Qnf3AS2pjcUM5SzxpApOrlndMeGhIbaTzWBzzP/IApXoNWEW7OhcjkRT48jnAUIFXhAQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/selector-specificity": "^5.0.0", + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-is-pseudo-class/node_modules/@csstools/selector-specificity": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", + "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/@csstools/postcss-is-pseudo-class/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@csstools/postcss-light-dark-function": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.11.tgz", + "integrity": "sha512-fNJcKXJdPM3Lyrbmgw2OBbaioU7yuKZtiXClf4sGdQttitijYlZMD5K7HrC/eF83VRWRrYq6OZ0Lx92leV2LFA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-float-and-clear": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-float-and-clear/-/postcss-logical-float-and-clear-3.0.0.tgz", + "integrity": "sha512-SEmaHMszwakI2rqKRJgE+8rpotFfne1ZS6bZqBoQIicFyV+xT1UF42eORPxJkVJVrH9C0ctUgwMSn3BLOIZldQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-overflow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-overflow/-/postcss-logical-overflow-2.0.0.tgz", + "integrity": "sha512-spzR1MInxPuXKEX2csMamshR4LRaSZ3UXVaRGjeQxl70ySxOhMpP2252RAFsg8QyyBXBzuVOOdx1+bVO5bPIzA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-overscroll-behavior": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-overscroll-behavior/-/postcss-logical-overscroll-behavior-2.0.0.tgz", + "integrity": "sha512-e/webMjoGOSYfqLunyzByZj5KKe5oyVg/YSbie99VEaSDE2kimFm0q1f6t/6Jo+VVCQ/jbe2Xy+uX+C4xzWs4w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-resize": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-resize/-/postcss-logical-resize-3.0.0.tgz", + "integrity": "sha512-DFbHQOFW/+I+MY4Ycd/QN6Dg4Hcbb50elIJCfnwkRTCX05G11SwViI5BbBlg9iHRl4ytB7pmY5ieAFk3ws7yyg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-viewport-units": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.4.tgz", + "integrity": "sha512-q+eHV1haXA4w9xBwZLKjVKAWn3W2CMqmpNpZUk5kRprvSiBEGMgrNH3/sJZ8UA3JgyHaOt3jwT9uFa4wLX4EqQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-media-minmax": { + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz", + "integrity": "sha512-af9Qw3uS3JhYLnCbqtZ9crTvvkR+0Se+bBqSr7ykAnl9yKhk6895z9rf+2F4dClIDJWxgn0iZZ1PSdkhrbs2ig==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/media-query-list-parser": "^4.0.3" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz", + "integrity": "sha512-zhAe31xaaXOY2Px8IYfoVTB3wglbJUVigGphFLj6exb7cjZRH9A6adyE22XfFK3P2PzwRk0VDeTJmaxpluyrDg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/media-query-list-parser": "^4.0.3" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-nested-calc": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-nested-calc/-/postcss-nested-calc-4.0.0.tgz", + "integrity": "sha512-jMYDdqrQQxE7k9+KjstC3NbsmC063n1FTPLCgCRS2/qHUbHM0mNy9pIn4QIiQGs9I/Bg98vMqw7mJXBxa0N88A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-normalize-display-values": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-normalize-display-values/-/postcss-normalize-display-values-4.0.1.tgz", + "integrity": "sha512-TQUGBuRvxdc7TgNSTevYqrL8oItxiwPDixk20qCB5me/W8uF7BPbhRrAvFuhEoywQp/woRsUZ6SJ+sU5idZAIA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-oklab-function": { + "version": "4.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.12.tgz", + "integrity": "sha512-HhlSmnE1NKBhXsTnNGjxvhryKtO7tJd1w42DKOGFD6jSHtYOrsJTQDKPMwvOfrzUAk8t7GcpIfRyM7ssqHpFjg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-position-area-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-position-area-property/-/postcss-position-area-property-1.0.0.tgz", + "integrity": "sha512-fUP6KR8qV2NuUZV3Cw8itx0Ep90aRjAZxAEzC3vrl6yjFv+pFsQbR18UuQctEKmA72K9O27CoYiKEgXxkqjg8Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-progressive-custom-properties": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.2.1.tgz", + "integrity": "sha512-uPiiXf7IEKtUQXsxu6uWtOlRMXd2QWWy5fhxHDnPdXKCQckPP3E34ZgDoZ62r2iT+UOgWsSbM4NvHE5m3mAEdw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-property-rule-prelude-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-property-rule-prelude-list/-/postcss-property-rule-prelude-list-1.0.0.tgz", + "integrity": "sha512-IxuQjUXq19fobgmSSvUDO7fVwijDJaZMvWQugxfEUxmjBeDCVaDuMpsZ31MsTm5xbnhA+ElDi0+rQ7sQQGisFA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-random-function": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz", + "integrity": "sha512-q+FQaNiRBhnoSNo+GzqGOIBKoHQ43lYz0ICrV+UudfWnEF6ksS6DsBIJSISKQT2Bvu3g4k6r7t0zYrk5pDlo8w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-relative-color-syntax": { + "version": "3.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.12.tgz", + "integrity": "sha512-0RLIeONxu/mtxRtf3o41Lq2ghLimw0w9ByLWnnEVuy89exmEEq8bynveBxNW3nyHqLAFEeNtVEmC1QK9MZ8Huw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-scope-pseudo-class": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-scope-pseudo-class/-/postcss-scope-pseudo-class-4.0.1.tgz", + "integrity": "sha512-IMi9FwtH6LMNuLea1bjVMQAsUhFxJnyLSgOp/cpv5hrzWmrUYU5fm0EguNDIIOHUqzXode8F/1qkC/tEo/qN8Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-scope-pseudo-class/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@csstools/postcss-sign-functions": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.4.tgz", + "integrity": "sha512-P97h1XqRPcfcJndFdG95Gv/6ZzxUBBISem0IDqPZ7WMvc/wlO+yU0c5D/OCpZ5TJoTt63Ok3knGk64N+o6L2Pg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-stepped-value-functions": { + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz", + "integrity": "sha512-h9btycWrsex4dNLeQfyU3y3w40LMQooJWFMm/SK9lrKguHDcFl4VMkncKKoXi2z5rM9YGWbUQABI8BT2UydIcA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-syntax-descriptor-syntax-production": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-syntax-descriptor-syntax-production/-/postcss-syntax-descriptor-syntax-production-1.0.1.tgz", + "integrity": "sha512-GneqQWefjM//f4hJ/Kbox0C6f2T7+pi4/fqTqOFGTL3EjnvOReTqO1qUQ30CaUjkwjYq9qZ41hzarrAxCc4gow==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-system-ui-font-family": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-system-ui-font-family/-/postcss-system-ui-font-family-1.0.0.tgz", + "integrity": "sha512-s3xdBvfWYfoPSBsikDXbuorcMG1nN1M6GdU0qBsGfcmNR0A/qhloQZpTxjA3Xsyrk1VJvwb2pOfiOT3at/DuIQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-text-decoration-shorthand": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz", + "integrity": "sha512-KSkGgZfx0kQjRIYnpsD7X2Om9BUXX/Kii77VBifQW9Ih929hK0KNjVngHDH0bFB9GmfWcR9vJYJJRvw/NQjkrA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-trigonometric-functions": { + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz", + "integrity": "sha512-Hnh5zJUdpNrJqK9v1/E3BbrQhaDTj5YiX7P61TOvUhoDHnUmsNNxcDAgkQ32RrcWx9GVUvfUNPcUkn8R3vIX6A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-unset-value": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz", + "integrity": "sha512-cBz3tOCI5Fw6NIFEwU3RiwK6mn3nKegjpJuzCndoGq3BZPkUjnsq7uQmIeMNeMbMk7YD2MfKcgCpZwX5jyXqCA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/utilities": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@csstools/utilities/-/utilities-2.0.0.tgz", + "integrity": "sha512-5VdOr0Z71u+Yp3ozOx8T11N703wIFGVRgOWbOZMKgglPJsWA54MRIoMNVMa7shUToIhx5J8vX4sOZgD2XiihiQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@discoveryjs/json-ext": { + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz", + "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", + "license": "MIT", + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/@docsearch/core": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/core/-/core-4.6.2.tgz", + "integrity": "sha512-/S0e6Dj7Zcm8m9Rru49YEX49dhU11be68c+S/BCyN8zQsTTgkKzXlhRbVL5mV6lOLC2+ZRRryaTdcm070Ug2oA==", + "license": "MIT", + "peerDependencies": { + "@types/react": ">= 16.8.0 < 20.0.0", + "react": ">= 16.8.0 < 20.0.0", + "react-dom": ">= 16.8.0 < 20.0.0" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + }, + "react": { + "optional": true + }, + "react-dom": { + "optional": true + } + } + }, + "node_modules/@docsearch/css": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/css/-/css-4.6.2.tgz", + "integrity": "sha512-fH/cn8BjEEdM2nJdjNMHIvOVYupG6AIDtFVDgIZrNzdCSj4KXr9kd+hsehqsNGYjpUjObeKYKvgy/IwCb1jZYQ==", + "license": "MIT" + }, + "node_modules/@docsearch/react": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/react/-/react-4.6.2.tgz", + "integrity": "sha512-/BbtGFtqVOGwZx0dw/UfhN/0/DmMQYnulY4iv0tPRhC2JCXv0ka/+izwt3Jzo1ZxXS/2eMvv9zHsBJOK1I9f/w==", + "license": "MIT", + "dependencies": { + "@algolia/autocomplete-core": "1.19.2", + "@docsearch/core": "4.6.2", + "@docsearch/css": "4.6.2" + }, + "peerDependencies": { + "@types/react": ">= 16.8.0 < 20.0.0", + "react": ">= 16.8.0 < 20.0.0", + "react-dom": ">= 16.8.0 < 20.0.0", + "search-insights": ">= 1 < 3" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + }, + "react": { + "optional": true + }, + "react-dom": { + "optional": true + }, + "search-insights": { + "optional": true + } + } + }, + "node_modules/@docusaurus/babel": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/babel/-/babel-3.9.2.tgz", + "integrity": "sha512-GEANdi/SgER+L7Japs25YiGil/AUDnFFHaCGPBbundxoWtCkA2lmy7/tFmgED4y1htAy6Oi4wkJEQdGssnw9MA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.25.9", + "@babel/generator": "^7.25.9", + "@babel/plugin-syntax-dynamic-import": "^7.8.3", + "@babel/plugin-transform-runtime": "^7.25.9", + "@babel/preset-env": "^7.25.9", + "@babel/preset-react": "^7.25.9", + "@babel/preset-typescript": "^7.25.9", + "@babel/runtime": "^7.25.9", + "@babel/runtime-corejs3": "^7.25.9", + "@babel/traverse": "^7.25.9", + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "babel-plugin-dynamic-import-node": "^2.3.3", + "fs-extra": "^11.1.1", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/bundler": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/bundler/-/bundler-3.9.2.tgz", + "integrity": "sha512-ZOVi6GYgTcsZcUzjblpzk3wH1Fya2VNpd5jtHoCCFcJlMQ1EYXZetfAnRHLcyiFeBABaI1ltTYbOBtH/gahGVA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.25.9", + "@docusaurus/babel": "3.9.2", + "@docusaurus/cssnano-preset": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "babel-loader": "^9.2.1", + "clean-css": "^5.3.3", + "copy-webpack-plugin": "^11.0.0", + "css-loader": "^6.11.0", + "css-minimizer-webpack-plugin": "^5.0.1", + "cssnano": "^6.1.2", + "file-loader": "^6.2.0", + "html-minifier-terser": "^7.2.0", + "mini-css-extract-plugin": "^2.9.2", + "null-loader": "^4.0.1", + "postcss": "^8.5.4", + "postcss-loader": "^7.3.4", + "postcss-preset-env": "^10.2.1", + "terser-webpack-plugin": "^5.3.9", + "tslib": "^2.6.0", + "url-loader": "^4.1.1", + "webpack": "^5.95.0", + "webpackbar": "^6.0.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "@docusaurus/faster": "*" + }, + "peerDependenciesMeta": { + "@docusaurus/faster": { + "optional": true + } + } + }, + "node_modules/@docusaurus/core": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/core/-/core-3.9.2.tgz", + "integrity": "sha512-HbjwKeC+pHUFBfLMNzuSjqFE/58+rLVKmOU3lxQrpsxLBOGosYco/Q0GduBb0/jEMRiyEqjNT/01rRdOMWq5pw==", + "license": "MIT", + "dependencies": { + "@docusaurus/babel": "3.9.2", + "@docusaurus/bundler": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "boxen": "^6.2.1", + "chalk": "^4.1.2", + "chokidar": "^3.5.3", + "cli-table3": "^0.6.3", + "combine-promises": "^1.1.0", + "commander": "^5.1.0", + "core-js": "^3.31.1", + "detect-port": "^1.5.1", + "escape-html": "^1.0.3", + "eta": "^2.2.0", + "eval": "^0.1.8", + "execa": "5.1.1", + "fs-extra": "^11.1.1", + "html-tags": "^3.3.1", + "html-webpack-plugin": "^5.6.0", + "leven": "^3.1.0", + "lodash": "^4.17.21", + "open": "^8.4.0", + "p-map": "^4.0.0", + "prompts": "^2.4.2", + "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", + "react-loadable": "npm:@docusaurus/react-loadable@6.0.0", + "react-loadable-ssr-addon-v5-slorber": "^1.0.1", + "react-router": "^5.3.4", + "react-router-config": "^5.1.1", + "react-router-dom": "^5.3.4", + "semver": "^7.5.4", + "serve-handler": "^6.1.6", + "tinypool": "^1.0.2", + "tslib": "^2.6.0", + "update-notifier": "^6.0.2", + "webpack": "^5.95.0", + "webpack-bundle-analyzer": "^4.10.2", + "webpack-dev-server": "^5.2.2", + "webpack-merge": "^6.0.1" + }, + "bin": { + "docusaurus": "bin/docusaurus.mjs" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "@mdx-js/react": "^3.0.0", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/cssnano-preset": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/cssnano-preset/-/cssnano-preset-3.9.2.tgz", + "integrity": "sha512-8gBKup94aGttRduABsj7bpPFTX7kbwu+xh3K9NMCF5K4bWBqTFYW+REKHF6iBVDHRJ4grZdIPbvkiHd/XNKRMQ==", + "license": "MIT", + "dependencies": { + "cssnano-preset-advanced": "^6.1.2", + "postcss": "^8.5.4", + "postcss-sort-media-queries": "^5.2.0", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/logger": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/logger/-/logger-3.9.2.tgz", + "integrity": "sha512-/SVCc57ByARzGSU60c50rMyQlBuMIJCjcsJlkphxY6B0GV4UH3tcA1994N8fFfbJ9kX3jIBe/xg3XP5qBtGDbA==", + "license": "MIT", + "dependencies": { + "chalk": "^4.1.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/mdx-loader": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/mdx-loader/-/mdx-loader-3.9.2.tgz", + "integrity": "sha512-wiYoGwF9gdd6rev62xDU8AAM8JuLI/hlwOtCzMmYcspEkzecKrP8J8X+KpYnTlACBUUtXNJpSoCwFWJhLRevzQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@mdx-js/mdx": "^3.0.0", + "@slorber/remark-comment": "^1.0.0", + "escape-html": "^1.0.3", + "estree-util-value-to-estree": "^3.0.1", + "file-loader": "^6.2.0", + "fs-extra": "^11.1.1", + "image-size": "^2.0.2", + "mdast-util-mdx": "^3.0.0", + "mdast-util-to-string": "^4.0.0", + "rehype-raw": "^7.0.0", + "remark-directive": "^3.0.0", + "remark-emoji": "^4.0.0", + "remark-frontmatter": "^5.0.0", + "remark-gfm": "^4.0.0", + "stringify-object": "^3.3.0", + "tslib": "^2.6.0", + "unified": "^11.0.3", + "unist-util-visit": "^5.0.0", + "url-loader": "^4.1.1", + "vfile": "^6.0.1", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/module-type-aliases": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/module-type-aliases/-/module-type-aliases-3.9.2.tgz", + "integrity": "sha512-8qVe2QA9hVLzvnxP46ysuofJUIc/yYQ82tvA/rBTrnpXtCjNSFLxEZfd5U8cYZuJIVlkPxamsIgwd5tGZXfvew==", + "license": "MIT", + "dependencies": { + "@docusaurus/types": "3.9.2", + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router-config": "*", + "@types/react-router-dom": "*", + "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", + "react-loadable": "npm:@docusaurus/react-loadable@6.0.0" + }, + "peerDependencies": { + "react": "*", + "react-dom": "*" + } + }, + "node_modules/@docusaurus/plugin-content-blog": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.9.2.tgz", + "integrity": "sha512-3I2HXy3L1QcjLJLGAoTvoBnpOwa6DPUa3Q0dMK19UTY9mhPkKQg/DYhAGTiBUKcTR0f08iw7kLPqOhIgdV3eVQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "cheerio": "1.0.0-rc.12", + "feed": "^4.2.2", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "schema-dts": "^1.1.2", + "srcset": "^4.0.0", + "tslib": "^2.6.0", + "unist-util-visit": "^5.0.0", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "@docusaurus/plugin-content-docs": "*", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-content-docs": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz", + "integrity": "sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@types/react-router-config": "^5.0.7", + "combine-promises": "^1.1.0", + "fs-extra": "^11.1.1", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "schema-dts": "^1.1.2", + "tslib": "^2.6.0", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-content-pages": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.9.2.tgz", + "integrity": "sha512-s4849w/p4noXUrGpPUF0BPqIAfdAe76BLaRGAGKZ1gTDNiGxGcpsLcwJ9OTi1/V8A+AzvsmI9pkjie2zjIQZKA==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "fs-extra": "^11.1.1", + "tslib": "^2.6.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-css-cascade-layers": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.9.2.tgz", + "integrity": "sha512-w1s3+Ss+eOQbscGM4cfIFBlVg/QKxyYgj26k5AnakuHkKxH6004ZtuLe5awMBotIYF2bbGDoDhpgQ4r/kcj4rQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/plugin-debug": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-debug/-/plugin-debug-3.9.2.tgz", + "integrity": "sha512-j7a5hWuAFxyQAkilZwhsQ/b3T7FfHZ+0dub6j/GxKNFJp2h9qk/P1Bp7vrGASnvA9KNQBBL1ZXTe7jlh4VdPdA==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "fs-extra": "^11.1.1", + "react-json-view-lite": "^2.3.0", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-analytics": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.9.2.tgz", + "integrity": "sha512-mAwwQJ1Us9jL/lVjXtErXto4p4/iaLlweC54yDUK1a97WfkC6Z2k5/769JsFgwOwOP+n5mUQGACXOEQ0XDuVUw==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-gtag": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.9.2.tgz", + "integrity": "sha512-YJ4lDCphabBtw19ooSlc1MnxtYGpjFV9rEdzjLsUnBCeis2djUyCozZaFhCg6NGEwOn7HDDyMh0yzcdRpnuIvA==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@types/gtag.js": "^0.0.12", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-tag-manager": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.9.2.tgz", + "integrity": "sha512-LJtIrkZN/tuHD8NqDAW1Tnw0ekOwRTfobWPsdO15YxcicBo2ykKF0/D6n0vVBfd3srwr9Z6rzrIWYrMzBGrvNw==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-sitemap": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.9.2.tgz", + "integrity": "sha512-WLh7ymgDXjG8oPoM/T4/zUP7KcSuFYRZAUTl8vR6VzYkfc18GBM4xLhcT+AKOwun6kBivYKUJf+vlqYJkm+RHw==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "fs-extra": "^11.1.1", + "sitemap": "^7.1.1", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-svgr": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-svgr/-/plugin-svgr-3.9.2.tgz", + "integrity": "sha512-n+1DE+5b3Lnf27TgVU5jM1d4x5tUh2oW5LTsBxJX4PsAPV0JGcmI6p3yLYtEY0LRVEIJh+8RsdQmRE66wSV8mw==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@svgr/core": "8.1.0", + "@svgr/webpack": "^8.1.0", + "tslib": "^2.6.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/preset-classic": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/preset-classic/-/preset-classic-3.9.2.tgz", + "integrity": "sha512-IgyYO2Gvaigi21LuDIe+nvmN/dfGXAiMcV/murFqcpjnZc7jxFAxW+9LEjdPt61uZLxG4ByW/oUmX/DDK9t/8w==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/plugin-content-blog": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/plugin-content-pages": "3.9.2", + "@docusaurus/plugin-css-cascade-layers": "3.9.2", + "@docusaurus/plugin-debug": "3.9.2", + "@docusaurus/plugin-google-analytics": "3.9.2", + "@docusaurus/plugin-google-gtag": "3.9.2", + "@docusaurus/plugin-google-tag-manager": "3.9.2", + "@docusaurus/plugin-sitemap": "3.9.2", + "@docusaurus/plugin-svgr": "3.9.2", + "@docusaurus/theme-classic": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-search-algolia": "3.9.2", + "@docusaurus/types": "3.9.2" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/theme-classic": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-classic/-/theme-classic-3.9.2.tgz", + "integrity": "sha512-IGUsArG5hhekXd7RDb11v94ycpJpFdJPkLnt10fFQWOVxAtq5/D7hT6lzc2fhyQKaaCE62qVajOMKL7OiAFAIA==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/plugin-content-blog": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/plugin-content-pages": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "infima": "0.2.0-alpha.45", + "lodash": "^4.17.21", + "nprogress": "^0.2.0", + "postcss": "^8.5.4", + "prism-react-renderer": "^2.3.0", + "prismjs": "^1.29.0", + "react-router-dom": "^5.3.4", + "rtlcss": "^4.1.0", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/theme-common": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.9.2.tgz", + "integrity": "sha512-6c4DAbR6n6nPbnZhY2V3tzpnKnGL+6aOsLvFL26VRqhlczli9eWG0VDUNoCQEPnGwDMhPS42UhSAnz5pThm5Ag==", + "license": "MIT", + "dependencies": { + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router-config": "*", + "clsx": "^2.0.0", + "parse-numeric-range": "^1.3.0", + "prism-react-renderer": "^2.3.0", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "@docusaurus/plugin-content-docs": "*", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/theme-search-algolia": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.9.2.tgz", + "integrity": "sha512-GBDSFNwjnh5/LdkxCKQHkgO2pIMX1447BxYUBG2wBiajS21uj64a+gH/qlbQjDLxmGrbrllBrtJkUHxIsiwRnw==", + "license": "MIT", + "dependencies": { + "@docsearch/react": "^3.9.0 || ^4.1.0", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "algoliasearch": "^5.37.0", + "algoliasearch-helper": "^3.26.0", + "clsx": "^2.0.0", + "eta": "^2.2.0", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/theme-translations": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-translations/-/theme-translations-3.9.2.tgz", + "integrity": "sha512-vIryvpP18ON9T9rjgMRFLr2xJVDpw1rtagEGf8Ccce4CkTrvM/fRB8N2nyWYOW5u3DdjkwKw5fBa+3tbn9P4PA==", + "license": "MIT", + "dependencies": { + "fs-extra": "^11.1.1", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/tsconfig": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/tsconfig/-/tsconfig-3.9.2.tgz", + "integrity": "sha512-j6/Fp4Rlpxsc632cnRnl5HpOWeb6ZKssDj6/XzzAzVGXXfm9Eptx3rxCC+fDzySn9fHTS+CWJjPineCR1bB5WQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@docusaurus/types": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/types/-/types-3.9.2.tgz", + "integrity": "sha512-Ux1JUNswg+EfUEmajJjyhIohKceitY/yzjRUpu04WXgvVz+fbhVC0p+R0JhvEu4ytw8zIAys2hrdpQPBHRIa8Q==", + "license": "MIT", + "dependencies": { + "@mdx-js/mdx": "^3.0.0", + "@types/history": "^4.7.11", + "@types/mdast": "^4.0.2", + "@types/react": "*", + "commander": "^5.1.0", + "joi": "^17.9.2", + "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", + "utility-types": "^3.10.0", + "webpack": "^5.95.0", + "webpack-merge": "^5.9.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/types/node_modules/webpack-merge": { + "version": "5.10.0", + "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz", + "integrity": "sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA==", + "license": "MIT", + "dependencies": { + "clone-deep": "^4.0.1", + "flat": "^5.0.2", + "wildcard": "^2.0.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/@docusaurus/utils": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/utils/-/utils-3.9.2.tgz", + "integrity": "sha512-lBSBiRruFurFKXr5Hbsl2thmGweAPmddhF3jb99U4EMDA5L+e5Y1rAkOS07Nvrup7HUMBDrCV45meaxZnt28nQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "escape-string-regexp": "^4.0.0", + "execa": "5.1.1", + "file-loader": "^6.2.0", + "fs-extra": "^11.1.1", + "github-slugger": "^1.5.0", + "globby": "^11.1.0", + "gray-matter": "^4.0.3", + "jiti": "^1.20.0", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "micromatch": "^4.0.5", + "p-queue": "^6.6.2", + "prompts": "^2.4.2", + "resolve-pathname": "^3.0.0", + "tslib": "^2.6.0", + "url-loader": "^4.1.1", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/utils-common": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/utils-common/-/utils-common-3.9.2.tgz", + "integrity": "sha512-I53UC1QctruA6SWLvbjbhCpAw7+X7PePoe5pYcwTOEXD/PxeP8LnECAhTHHwWCblyUX5bMi4QLRkxvyZ+IT8Aw==", + "license": "MIT", + "dependencies": { + "@docusaurus/types": "3.9.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/utils-validation": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/utils-validation/-/utils-validation-3.9.2.tgz", + "integrity": "sha512-l7yk3X5VnNmATbwijJkexdhulNsQaNDwoagiwujXoxFbWLcxHQqNQ+c/IAlzrfMMOfa/8xSBZ7KEKDesE/2J7A==", + "license": "MIT", + "dependencies": { + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "fs-extra": "^11.2.0", + "joi": "^17.9.2", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@hapi/hoek": { + "version": "9.3.0", + "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", + "integrity": "sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==", + "license": "BSD-3-Clause" + }, + "node_modules/@hapi/topo": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@hapi/topo/-/topo-5.1.0.tgz", + "integrity": "sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==", + "license": "BSD-3-Clause", + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@jest/schemas": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", + "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", + "license": "MIT", + "dependencies": { + "@sinclair/typebox": "^0.27.8" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/types": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.6.3.tgz", + "integrity": "sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==", + "license": "MIT", + "dependencies": { + "@jest/schemas": "^29.6.3", + "@types/istanbul-lib-coverage": "^2.0.0", + "@types/istanbul-reports": "^3.0.0", + "@types/node": "*", + "@types/yargs": "^17.0.8", + "chalk": "^4.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/remapping": { + "version": "2.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/remapping/-/remapping-2.3.5.tgz", + "integrity": "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==", + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/source-map": { + "version": "0.3.11", + "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.11.tgz", + "integrity": "sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA==", + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@jsonjoy.com/base64": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/base64/-/base64-1.1.2.tgz", + "integrity": "sha512-q6XAnWQDIMA3+FTiOYajoYqySkO+JSat0ytXGSuRdq9uXE7o92gzuQwQM14xaCRlBLGq3v5miDGC4vkVTn54xA==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/buffers": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-17.67.0.tgz", + "integrity": "sha512-tfExRpYxBvi32vPs9ZHaTjSP4fHAfzSmcahOfNxtvGHcyJel+aibkPlGeBB+7AoC6hL7lXIE++8okecBxx7lcw==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/codegen": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/codegen/-/codegen-1.0.0.tgz", + "integrity": "sha512-E8Oy+08cmCf0EK/NMxpaJZmOxPqM+6iSe2S4nlSBrPZOORoDJILxtbSUEDKQyTamm/BVAhIGllOBNU79/dwf0g==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-core": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-core/-/fs-core-4.57.1.tgz", + "integrity": "sha512-YrEi/ZPmgc+GfdO0esBF04qv8boK9Dg9WpRQw/+vM8Qt3nnVIJWIa8HwZ/LXVZ0DB11XUROM8El/7yYTJX+WtA==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "thingies": "^2.5.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-fsa": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-fsa/-/fs-fsa-4.57.1.tgz", + "integrity": "sha512-ooEPvSW/HQDivPDPZMibHGKZf/QS4WRir1czGZmXmp3MsQqLECZEpN0JobrD8iV9BzsuwdIv+PxtWX9WpPLsIA==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-core": "4.57.1", + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "thingies": "^2.5.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-node": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node/-/fs-node-4.57.1.tgz", + "integrity": "sha512-3YaKhP8gXEKN+2O49GLNfNb5l2gbnCFHyAaybbA2JkkbQP3dpdef7WcUaHAulg/c5Dg4VncHsA3NWAUSZMR5KQ==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-core": "4.57.1", + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "@jsonjoy.com/fs-print": "4.57.1", + "@jsonjoy.com/fs-snapshot": "4.57.1", + "glob-to-regex.js": "^1.0.0", + "thingies": "^2.5.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-node-builtins": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-builtins/-/fs-node-builtins-4.57.1.tgz", + "integrity": "sha512-XHkFKQ5GSH3uxm8c3ZYXVrexGdscpWKIcMWKFQpMpMJc8gA3AwOMBJXJlgpdJqmrhPyQXxaY9nbkNeYpacC0Og==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-node-to-fsa": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-to-fsa/-/fs-node-to-fsa-4.57.1.tgz", + "integrity": "sha512-pqGHyWWzNck4jRfaGV39hkqpY5QjRUQ/nRbNT7FYbBa0xf4bDG+TE1Gt2KWZrSkrkZZDE3qZUjYMbjwSliX6pg==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-fsa": "4.57.1", + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-node-utils": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-utils/-/fs-node-utils-4.57.1.tgz", + "integrity": "sha512-vp+7ZzIB8v43G+GLXTS4oDUSQmhAsRz532QmmWBbdYA20s465JvwhkSFvX9cVTqRRAQg+vZ7zWDaIEh0lFe2gw==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-node-builtins": "4.57.1" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-print": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-print/-/fs-print-4.57.1.tgz", + "integrity": "sha512-Ynct7ZJmfk6qoXDOKfpovNA36ITUx8rChLmRQtW08J73VOiuNsU8PB6d/Xs7fxJC2ohWR3a5AqyjmLojfrw5yw==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-node-utils": "4.57.1", + "tree-dump": "^1.1.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-snapshot/-/fs-snapshot-4.57.1.tgz", + "integrity": "sha512-/oG8xBNFMbDXTq9J7vepSA1kerS5vpgd3p5QZSPd+nX59uwodGJftI51gDYyHRpP57P3WCQf7LHtBYPqwUg2Bg==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/buffers": "^17.65.0", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "@jsonjoy.com/json-pack": "^17.65.0", + "@jsonjoy.com/util": "^17.65.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/base64": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/base64/-/base64-17.67.0.tgz", + "integrity": "sha512-5SEsJGsm15aP8TQGkDfJvz9axgPwAEm98S5DxOuYe8e1EbfajcDmgeXXzccEjh+mLnjqEKrkBdjHWS5vFNwDdw==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/codegen": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/codegen/-/codegen-17.67.0.tgz", + "integrity": "sha512-idnkUplROpdBOV0HMcwhsCUS5TRUi9poagdGs70A6S4ux9+/aPuKbh8+UYRTLYQHtXvAdNfQWXDqZEx5k4Dj2Q==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/json-pack": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pack/-/json-pack-17.67.0.tgz", + "integrity": "sha512-t0ejURcGaZsn1ClbJ/3kFqSOjlryd92eQY465IYrezsXmPcfHPE/av4twRSxf6WE+TkZgLY+71vCZbiIiFKA/w==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/base64": "17.67.0", + "@jsonjoy.com/buffers": "17.67.0", + "@jsonjoy.com/codegen": "17.67.0", + "@jsonjoy.com/json-pointer": "17.67.0", + "@jsonjoy.com/util": "17.67.0", + "hyperdyperid": "^1.2.0", + "thingies": "^2.5.0", + "tree-dump": "^1.1.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/json-pointer": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pointer/-/json-pointer-17.67.0.tgz", + "integrity": "sha512-+iqOFInH+QZGmSuaybBUNdh7yvNrXvqR+h3wjXm0N/3JK1EyyFAeGJvqnmQL61d1ARLlk/wJdFKSL+LHJ1eaUA==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/util": "17.67.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/util": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/util/-/util-17.67.0.tgz", + "integrity": "sha512-6+8xBaz1rLSohlGh68D1pdw3AwDi9xydm8QNlAFkvnavCJYSze+pxoW2VKP8p308jtlMRLs5NTHfPlZLd4w7ew==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/buffers": "17.67.0", + "@jsonjoy.com/codegen": "17.67.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/json-pack": { + "version": "1.21.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pack/-/json-pack-1.21.0.tgz", + "integrity": "sha512-+AKG+R2cfZMShzrF2uQw34v3zbeDYUqnQ+jg7ORic3BGtfw9p/+N6RJbq/kkV8JmYZaINknaEQ2m0/f693ZPpg==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/base64": "^1.1.2", + "@jsonjoy.com/buffers": "^1.2.0", + "@jsonjoy.com/codegen": "^1.0.0", + "@jsonjoy.com/json-pointer": "^1.0.2", + "@jsonjoy.com/util": "^1.9.0", + "hyperdyperid": "^1.2.0", + "thingies": "^2.5.0", + "tree-dump": "^1.1.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/json-pack/node_modules/@jsonjoy.com/buffers": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz", + "integrity": "sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/json-pointer": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pointer/-/json-pointer-1.0.2.tgz", + "integrity": "sha512-Fsn6wM2zlDzY1U+v4Nc8bo3bVqgfNTGcn6dMgs6FjrEnt4ZCe60o6ByKRjOGlI2gow0aE/Q41QOigdTqkyK5fg==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/codegen": "^1.0.0", + "@jsonjoy.com/util": "^1.9.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/util": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/util/-/util-1.9.0.tgz", + "integrity": "sha512-pLuQo+VPRnN8hfPqUTLTHk126wuYdXVxE6aDmjSeV4NCAgyxWbiOIeNJVtID3h1Vzpoi9m4jXezf73I6LgabgQ==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/buffers": "^1.0.0", + "@jsonjoy.com/codegen": "^1.0.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/util/node_modules/@jsonjoy.com/buffers": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz", + "integrity": "sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@leichtgewicht/ip-codec": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz", + "integrity": "sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw==", + "license": "MIT" + }, + "node_modules/@mdx-js/mdx": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@mdx-js/mdx/-/mdx-3.1.1.tgz", + "integrity": "sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdx": "^2.0.0", + "acorn": "^8.0.0", + "collapse-white-space": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-util-scope": "^1.0.0", + "estree-walker": "^3.0.0", + "hast-util-to-jsx-runtime": "^2.0.0", + "markdown-extensions": "^2.0.0", + "recma-build-jsx": "^1.0.0", + "recma-jsx": "^1.0.0", + "recma-stringify": "^1.0.0", + "rehype-recma": "^1.0.0", + "remark-mdx": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.0.0", + "source-map": "^0.7.0", + "unified": "^11.0.0", + "unist-util-position-from-estree": "^2.0.0", + "unist-util-stringify-position": "^4.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/@mdx-js/react": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz", + "integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==", + "license": "MIT", + "dependencies": { + "@types/mdx": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + }, + "peerDependencies": { + "@types/react": ">=16", + "react": ">=16" + } + }, + "node_modules/@noble/hashes": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@noble/hashes/-/hashes-1.4.0.tgz", + "integrity": "sha512-V1JJ1WTRUqHHrOSh597hURcMqVKVGL/ea3kv0gSnEdsEZ0/+VyPghM1lMNGc00z7CIQorSvbKpuJkxvuHbvdbg==", + "license": "MIT", + "engines": { + "node": ">= 16" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@peculiar/asn1-cms": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-cms/-/asn1-cms-2.6.1.tgz", + "integrity": "sha512-vdG4fBF6Lkirkcl53q6eOdn3XYKt+kJTG59edgRZORlg/3atWWEReRCx5rYE1ZzTTX6vLK5zDMjHh7vbrcXGtw==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "@peculiar/asn1-x509-attr": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-csr": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-csr/-/asn1-csr-2.6.1.tgz", + "integrity": "sha512-WRWnKfIocHyzFYQTka8O/tXCiBquAPSrRjXbOkHbO4qdmS6loffCEGs+rby6WxxGdJCuunnhS2duHURhjyio6w==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-ecc": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-ecc/-/asn1-ecc-2.6.1.tgz", + "integrity": "sha512-+Vqw8WFxrtDIN5ehUdvlN2m73exS2JVG0UAyfVB31gIfor3zWEAQPD+K9ydCxaj3MLen9k0JhKpu9LqviuCE1g==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-pfx": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-pfx/-/asn1-pfx-2.6.1.tgz", + "integrity": "sha512-nB5jVQy3MAAWvq0KY0R2JUZG8bO/bTLpnwyOzXyEh/e54ynGTatAR+csOnXkkVD9AFZ2uL8Z7EV918+qB1qDvw==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-cms": "^2.6.1", + "@peculiar/asn1-pkcs8": "^2.6.1", + "@peculiar/asn1-rsa": "^2.6.1", + "@peculiar/asn1-schema": "^2.6.0", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-pkcs8": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-pkcs8/-/asn1-pkcs8-2.6.1.tgz", + "integrity": "sha512-JB5iQ9Izn5yGMw3ZG4Nw3Xn/hb/G38GYF3lf7WmJb8JZUydhVGEjK/ZlFSWhnlB7K/4oqEs8HnfFIKklhR58Tw==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-pkcs9": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-pkcs9/-/asn1-pkcs9-2.6.1.tgz", + "integrity": "sha512-5EV8nZoMSxeWmcxWmmcolg22ojZRgJg+Y9MX2fnE2bGRo5KQLqV5IL9kdSQDZxlHz95tHvIq9F//bvL1OeNILw==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-cms": "^2.6.1", + "@peculiar/asn1-pfx": "^2.6.1", + "@peculiar/asn1-pkcs8": "^2.6.1", + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "@peculiar/asn1-x509-attr": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-rsa": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-rsa/-/asn1-rsa-2.6.1.tgz", + "integrity": "sha512-1nVMEh46SElUt5CB3RUTV4EG/z7iYc7EoaDY5ECwganibQPkZ/Y2eMsTKB/LeyrUJ+W/tKoD9WUqIy8vB+CEdA==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-schema": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-schema/-/asn1-schema-2.6.0.tgz", + "integrity": "sha512-xNLYLBFTBKkCzEZIw842BxytQQATQv+lDTCEMZ8C196iJcJJMBUZxrhSTxLaohMyKK8QlzRNTRkUmanucnDSqg==", + "license": "MIT", + "dependencies": { + "asn1js": "^3.0.6", + "pvtsutils": "^1.3.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-x509": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-x509/-/asn1-x509-2.6.1.tgz", + "integrity": "sha512-O9jT5F1A2+t3r7C4VT7LYGXqkGLK7Kj1xFpz7U0isPrubwU5PbDoyYtx6MiGst29yq7pXN5vZbQFKRCP+lLZlA==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "asn1js": "^3.0.6", + "pvtsutils": "^1.3.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-x509-attr": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-x509-attr/-/asn1-x509-attr-2.6.1.tgz", + "integrity": "sha512-tlW6cxoHwgcQghnJwv3YS+9OO1737zgPogZ+CgWRUK4roEwIPzRH4JEiG770xe5HX2ATfCpmX60gurfWIF9dcQ==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/x509": { + "version": "1.14.3", + "resolved": "https://registry.npmjs.org/@peculiar/x509/-/x509-1.14.3.tgz", + "integrity": "sha512-C2Xj8FZ0uHWeCXXqX5B4/gVFQmtSkiuOolzAgutjTfseNOHT3pUjljDZsTSxXFGgio54bCzVFqmEOUrIVk8RDA==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-cms": "^2.6.0", + "@peculiar/asn1-csr": "^2.6.0", + "@peculiar/asn1-ecc": "^2.6.0", + "@peculiar/asn1-pkcs9": "^2.6.0", + "@peculiar/asn1-rsa": "^2.6.0", + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.0", + "pvtsutils": "^1.3.6", + "reflect-metadata": "^0.2.2", + "tslib": "^2.8.1", + "tsyringe": "^4.10.0" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@pnpm/config.env-replace": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz", + "integrity": "sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w==", + "license": "MIT", + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.2.tgz", + "integrity": "sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA==", + "license": "MIT", + "dependencies": { + "graceful-fs": "4.2.10" + }, + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file/node_modules/graceful-fs": { + "version": "4.2.10", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", + "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", + "license": "ISC" + }, + "node_modules/@pnpm/npm-conf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-3.0.2.tgz", + "integrity": "sha512-h104Kh26rR8tm+a3Qkc5S4VLYint3FE48as7+/5oCEcKR2idC/pF1G6AhIXKI+eHPJa/3J9i5z0Al47IeGHPkA==", + "license": "MIT", + "dependencies": { + "@pnpm/config.env-replace": "^1.1.0", + "@pnpm/network.ca-file": "^1.0.1", + "config-chain": "^1.1.11" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@polka/url": { + "version": "1.0.0-next.29", + "resolved": "https://registry.npmjs.org/@polka/url/-/url-1.0.0-next.29.tgz", + "integrity": "sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww==", + "license": "MIT" + }, + "node_modules/@sideway/address": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz", + "integrity": "sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q==", + "license": "BSD-3-Clause", + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@sideway/formula": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@sideway/formula/-/formula-3.0.1.tgz", + "integrity": "sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg==", + "license": "BSD-3-Clause" + }, + "node_modules/@sideway/pinpoint": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@sideway/pinpoint/-/pinpoint-2.0.0.tgz", + "integrity": "sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ==", + "license": "BSD-3-Clause" + }, + "node_modules/@sinclair/typebox": { + "version": "0.27.10", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.10.tgz", + "integrity": "sha512-MTBk/3jGLNB2tVxv6uLlFh1iu64iYOQ2PbdOSK3NW8JZsmlaOh2q6sdtKowBhfw8QFLmYNzTW4/oK4uATIi6ZA==", + "license": "MIT" + }, + "node_modules/@sindresorhus/is": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", + "integrity": "sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/is?sponsor=1" + } + }, + "node_modules/@slorber/remark-comment": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@slorber/remark-comment/-/remark-comment-1.0.0.tgz", + "integrity": "sha512-RCE24n7jsOj1M0UPvIQCHTe7fI0sFL4S2nwKVWwHyVr/wI/H8GosgsJGyhnsZoGFnD/P2hLf1mSbrrgSLN93NA==", + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^1.0.0", + "micromark-util-character": "^1.1.0", + "micromark-util-symbol": "^1.0.1" + } + }, + "node_modules/@svgr/babel-plugin-add-jsx-attribute": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz", + "integrity": "sha512-b9MIk7yhdS1pMCZM8VeNfUlSKVRhsHZNMl5O9SfaX0l0t5wjdgu4IDzGB8bpnGBBOjGST3rRFVsaaEtI4W6f7g==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-remove-jsx-attribute": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-attribute/-/babel-plugin-remove-jsx-attribute-8.0.0.tgz", + "integrity": "sha512-BcCkm/STipKvbCl6b7QFrMh/vx00vIP63k2eM66MfHJzPr6O2U0jYEViXkHJWqXqQYjdeA9cuCl5KWmlwjDvbA==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-remove-jsx-empty-expression": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-empty-expression/-/babel-plugin-remove-jsx-empty-expression-8.0.0.tgz", + "integrity": "sha512-5BcGCBfBxB5+XSDSWnhTThfI9jcO5f0Ai2V24gZpG+wXF14BzwxxdDb4g6trdOux0rhibGs385BeFMSmxtS3uA==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-replace-jsx-attribute-value": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-replace-jsx-attribute-value/-/babel-plugin-replace-jsx-attribute-value-8.0.0.tgz", + "integrity": "sha512-KVQ+PtIjb1BuYT3ht8M5KbzWBhdAjjUPdlMtpuw/VjT8coTrItWX6Qafl9+ji831JaJcu6PJNKCV0bp01lBNzQ==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-svg-dynamic-title": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-dynamic-title/-/babel-plugin-svg-dynamic-title-8.0.0.tgz", + "integrity": "sha512-omNiKqwjNmOQJ2v6ge4SErBbkooV2aAWwaPFs2vUY7p7GhVkzRkJ00kILXQvRhA6miHnNpXv7MRnnSjdRjK8og==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-svg-em-dimensions": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-em-dimensions/-/babel-plugin-svg-em-dimensions-8.0.0.tgz", + "integrity": "sha512-mURHYnu6Iw3UBTbhGwE/vsngtCIbHE43xCRK7kCw4t01xyGqb2Pd+WXekRRoFOBIY29ZoOhUCTEweDMdrjfi9g==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-transform-react-native-svg": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-react-native-svg/-/babel-plugin-transform-react-native-svg-8.1.0.tgz", + "integrity": "sha512-Tx8T58CHo+7nwJ+EhUwx3LfdNSG9R2OKfaIXXs5soiy5HtgoAEkDay9LIimLOcG8dJQH1wPZp/cnAv6S9CrR1Q==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-transform-svg-component": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-svg-component/-/babel-plugin-transform-svg-component-8.0.0.tgz", + "integrity": "sha512-DFx8xa3cZXTdb/k3kfPeaixecQLgKh5NVBMwD0AQxOzcZawK4oo1Jh9LbrcACUivsCA7TLG8eeWgrDXjTMhRmw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-preset": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-preset/-/babel-preset-8.1.0.tgz", + "integrity": "sha512-7EYDbHE7MxHpv4sxvnVPngw5fuR6pw79SkcrILHJ/iMpuKySNCl5W1qcwPEpU+LgyRXOaAFgH0KhwD18wwg6ug==", + "license": "MIT", + "dependencies": { + "@svgr/babel-plugin-add-jsx-attribute": "8.0.0", + "@svgr/babel-plugin-remove-jsx-attribute": "8.0.0", + "@svgr/babel-plugin-remove-jsx-empty-expression": "8.0.0", + "@svgr/babel-plugin-replace-jsx-attribute-value": "8.0.0", + "@svgr/babel-plugin-svg-dynamic-title": "8.0.0", + "@svgr/babel-plugin-svg-em-dimensions": "8.0.0", + "@svgr/babel-plugin-transform-react-native-svg": "8.1.0", + "@svgr/babel-plugin-transform-svg-component": "8.0.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/core": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", + "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.21.3", + "@svgr/babel-preset": "8.1.0", + "camelcase": "^6.2.0", + "cosmiconfig": "^8.1.3", + "snake-case": "^3.0.4" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@svgr/hast-util-to-babel-ast": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/hast-util-to-babel-ast/-/hast-util-to-babel-ast-8.0.0.tgz", + "integrity": "sha512-EbDKwO9GpfWP4jN9sGdYwPBU0kdomaPIL2Eu4YwmgP+sJeXT+L7bMwJUBnhzfH8Q2qMBqZ4fJwpCyYsAN3mt2Q==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.21.3", + "entities": "^4.4.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@svgr/plugin-jsx": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/plugin-jsx/-/plugin-jsx-8.1.0.tgz", + "integrity": "sha512-0xiIyBsLlr8quN+WyuxooNW9RJ0Dpr8uOnH/xrCVO8GLUcwHISwj1AG0k+LFzteTkAA0GbX0kj9q6Dk70PTiPA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.21.3", + "@svgr/babel-preset": "8.1.0", + "@svgr/hast-util-to-babel-ast": "8.0.0", + "svg-parser": "^2.0.4" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@svgr/core": "*" + } + }, + "node_modules/@svgr/plugin-svgo": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/plugin-svgo/-/plugin-svgo-8.1.0.tgz", + "integrity": "sha512-Ywtl837OGO9pTLIN/onoWLmDQ4zFUycI1g76vuKGEz6evR/ZTJlJuz3G/fIkb6OVBJ2g0o6CGJzaEjfmEo3AHA==", + "license": "MIT", + "dependencies": { + "cosmiconfig": "^8.1.3", + "deepmerge": "^4.3.1", + "svgo": "^3.0.2" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@svgr/core": "*" + } + }, + "node_modules/@svgr/webpack": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/webpack/-/webpack-8.1.0.tgz", + "integrity": "sha512-LnhVjMWyMQV9ZmeEy26maJk+8HTIbd59cH4F2MJ439k9DqejRisfFNGAPvRYlKETuh9LrImlS8aKsBgKjMA8WA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.21.3", + "@babel/plugin-transform-react-constant-elements": "^7.21.3", + "@babel/preset-env": "^7.20.2", + "@babel/preset-react": "^7.18.6", + "@babel/preset-typescript": "^7.21.0", + "@svgr/core": "8.1.0", + "@svgr/plugin-jsx": "8.1.0", + "@svgr/plugin-svgo": "8.1.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@szmarczak/http-timer": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-5.0.1.tgz", + "integrity": "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==", + "license": "MIT", + "dependencies": { + "defer-to-connect": "^2.0.1" + }, + "engines": { + "node": ">=14.16" + } + }, + "node_modules/@types/body-parser": { + "version": "1.19.6", + "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.6.tgz", + "integrity": "sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g==", + "license": "MIT", + "dependencies": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "node_modules/@types/bonjour": { + "version": "3.5.13", + "resolved": "https://registry.npmjs.org/@types/bonjour/-/bonjour-3.5.13.tgz", + "integrity": "sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect": { + "version": "3.4.38", + "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", + "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect-history-api-fallback": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz", + "integrity": "sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw==", + "license": "MIT", + "dependencies": { + "@types/express-serve-static-core": "*", + "@types/node": "*" + } + }, + "node_modules/@types/debug": { + "version": "4.1.13", + "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.13.tgz", + "integrity": "sha512-KSVgmQmzMwPlmtljOomayoR89W4FynCAi3E8PPs7vmDVPe84hT+vGPKkJfThkmXs0x0jAaa9U8uW8bbfyS2fWw==", + "license": "MIT", + "dependencies": { + "@types/ms": "*" + } + }, + "node_modules/@types/eslint": { + "version": "9.6.1", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-9.6.1.tgz", + "integrity": "sha512-FXx2pKgId/WyYo2jXw63kk7/+TY7u7AziEJxJAnSFzHlqTAS3Ync6SvgYAN/k4/PQpnnVuzoMuVnByKK2qp0ag==", + "license": "MIT", + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + } + }, + "node_modules/@types/eslint-scope": { + "version": "3.7.7", + "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.7.tgz", + "integrity": "sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg==", + "license": "MIT", + "dependencies": { + "@types/eslint": "*", + "@types/estree": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "license": "MIT" + }, + "node_modules/@types/estree-jsx": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree-jsx/-/estree-jsx-1.0.5.tgz", + "integrity": "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg==", + "license": "MIT", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/@types/express": { + "version": "4.17.25", + "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.25.tgz", + "integrity": "sha512-dVd04UKsfpINUnK0yBoYHDF3xu7xVH4BuDotC/xGuycx4CgbP48X/KF/586bcObxT0HENHXEU8Nqtu6NR+eKhw==", + "license": "MIT", + "dependencies": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.33", + "@types/qs": "*", + "@types/serve-static": "^1" + } + }, + "node_modules/@types/express-serve-static-core": { + "version": "4.19.8", + "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.8.tgz", + "integrity": "sha512-02S5fmqeoKzVZCHPZid4b8JH2eM5HzQLZWN2FohQEy/0eXTq8VXZfSN6Pcr3F6N9R/vNrj7cpgbhjie6m/1tCA==", + "license": "MIT", + "dependencies": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*", + "@types/send": "*" + } + }, + "node_modules/@types/gtag.js": { + "version": "0.0.12", + "resolved": "https://registry.npmjs.org/@types/gtag.js/-/gtag.js-0.0.12.tgz", + "integrity": "sha512-YQV9bUsemkzG81Ea295/nF/5GijnD2Af7QhEofh7xu+kvCN6RdodgNwwGWXB5GMI3NoyvQo0odNctoH/qLMIpg==", + "license": "MIT" + }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/history": { + "version": "4.7.11", + "resolved": "https://registry.npmjs.org/@types/history/-/history-4.7.11.tgz", + "integrity": "sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA==", + "license": "MIT" + }, + "node_modules/@types/html-minifier-terser": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", + "integrity": "sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg==", + "license": "MIT" + }, + "node_modules/@types/http-cache-semantics": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", + "integrity": "sha512-L3LgimLHXtGkWikKnsPg0/VFx9OGZaC+eN1u4r+OB1XRqH3meBIAVC2zr1WdMH+RHmnRkqliQAOHNJ/E0j/e0Q==", + "license": "MIT" + }, + "node_modules/@types/http-errors": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.5.tgz", + "integrity": "sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg==", + "license": "MIT" + }, + "node_modules/@types/http-proxy": { + "version": "1.17.17", + "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.17.tgz", + "integrity": "sha512-ED6LB+Z1AVylNTu7hdzuBqOgMnvG/ld6wGCG8wFnAzKX5uyW2K3WD52v0gnLCTK/VLpXtKckgWuyScYK6cSPaw==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/istanbul-lib-coverage": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", + "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", + "license": "MIT" + }, + "node_modules/@types/istanbul-lib-report": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", + "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-coverage": "*" + } + }, + "node_modules/@types/istanbul-reports": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", + "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-report": "*" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "license": "MIT" + }, + "node_modules/@types/mdast": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", + "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/mdx": { + "version": "2.0.13", + "resolved": "https://registry.npmjs.org/@types/mdx/-/mdx-2.0.13.tgz", + "integrity": "sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw==", + "license": "MIT" + }, + "node_modules/@types/mime": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", + "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==", + "license": "MIT" + }, + "node_modules/@types/ms": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz", + "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==", + "license": "MIT" + }, + "node_modules/@types/node": { + "version": "25.5.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-25.5.0.tgz", + "integrity": "sha512-jp2P3tQMSxWugkCUKLRPVUpGaL5MVFwF8RDuSRztfwgN1wmqJeMSbKlnEtQqU8UrhTmzEmZdu2I6v2dpp7XIxw==", + "license": "MIT", + "dependencies": { + "undici-types": "~7.18.0" + } + }, + "node_modules/@types/prismjs": { + "version": "1.26.6", + "resolved": "https://registry.npmjs.org/@types/prismjs/-/prismjs-1.26.6.tgz", + "integrity": "sha512-vqlvI7qlMvcCBbVe0AKAb4f97//Hy0EBTaiW8AalRnG/xAN5zOiWWyrNqNXeq8+KAuvRewjCVY1+IPxk4RdNYw==", + "license": "MIT" + }, + "node_modules/@types/qs": { + "version": "6.15.0", + "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.15.0.tgz", + "integrity": "sha512-JawvT8iBVWpzTrz3EGw9BTQFg3BQNmwERdKE22vlTxawwtbyUSlMppvZYKLZzB5zgACXdXxbD3m1bXaMqP/9ow==", + "license": "MIT" + }, + "node_modules/@types/range-parser": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz", + "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", + "license": "MIT" + }, + "node_modules/@types/react": { + "version": "19.2.14", + "resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.14.tgz", + "integrity": "sha512-ilcTH/UniCkMdtexkoCN0bI7pMcJDvmQFPvuPvmEaYA/NSfFTAgdUSLAoVjaRJm7+6PvcM+q1zYOwS4wTYMF9w==", + "license": "MIT", + "dependencies": { + "csstype": "^3.2.2" + } + }, + "node_modules/@types/react-router": { + "version": "5.1.20", + "resolved": "https://registry.npmjs.org/@types/react-router/-/react-router-5.1.20.tgz", + "integrity": "sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q==", + "license": "MIT", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*" + } + }, + "node_modules/@types/react-router-config": { + "version": "5.0.11", + "resolved": "https://registry.npmjs.org/@types/react-router-config/-/react-router-config-5.0.11.tgz", + "integrity": "sha512-WmSAg7WgqW7m4x8Mt4N6ZyKz0BubSj/2tVUMsAHp+Yd2AMwcSbeFq9WympT19p5heCFmF97R9eD5uUR/t4HEqw==", + "license": "MIT", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router": "^5.1.0" + } + }, + "node_modules/@types/react-router-dom": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/@types/react-router-dom/-/react-router-dom-5.3.3.tgz", + "integrity": "sha512-kpqnYK4wcdm5UaWI3fLcELopqLrHgLqNsdpHauzlQktfkHL3npOSwtj1Uz9oKBAzs7lFtVkV8j83voAz2D8fhw==", + "license": "MIT", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router": "*" + } + }, + "node_modules/@types/retry": { + "version": "0.12.2", + "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.2.tgz", + "integrity": "sha512-XISRgDJ2Tc5q4TRqvgJtzsRkFYNJzZrhTdtMoGVBttwzzQJkPnS3WWTFc7kuDRoPtPakl+T+OfdEUjYJj7Jbow==", + "license": "MIT" + }, + "node_modules/@types/sax": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.7.tgz", + "integrity": "sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/send": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@types/send/-/send-1.2.1.tgz", + "integrity": "sha512-arsCikDvlU99zl1g69TcAB3mzZPpxgw0UQnaHeC1Nwb015xp8bknZv5rIfri9xTOcMuaVgvabfIRA7PSZVuZIQ==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/serve-index": { + "version": "1.9.4", + "resolved": "https://registry.npmjs.org/@types/serve-index/-/serve-index-1.9.4.tgz", + "integrity": "sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug==", + "license": "MIT", + "dependencies": { + "@types/express": "*" + } + }, + "node_modules/@types/serve-static": { + "version": "1.15.10", + "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.10.tgz", + "integrity": "sha512-tRs1dB+g8Itk72rlSI2ZrW6vZg0YrLI81iQSTkMmOqnqCaNr/8Ek4VwWcN5vZgCYWbg/JJSGBlUaYGAOP73qBw==", + "license": "MIT", + "dependencies": { + "@types/http-errors": "*", + "@types/node": "*", + "@types/send": "<1" + } + }, + "node_modules/@types/serve-static/node_modules/@types/send": { + "version": "0.17.6", + "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.6.tgz", + "integrity": "sha512-Uqt8rPBE8SY0RK8JB1EzVOIZ32uqy8HwdxCnoCOsYrvnswqmFZ/k+9Ikidlk/ImhsdvBsloHbAlewb2IEBV/Og==", + "license": "MIT", + "dependencies": { + "@types/mime": "^1", + "@types/node": "*" + } + }, + "node_modules/@types/sockjs": { + "version": "0.3.36", + "resolved": "https://registry.npmjs.org/@types/sockjs/-/sockjs-0.3.36.tgz", + "integrity": "sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "license": "MIT" + }, + "node_modules/@types/ws": { + "version": "8.18.1", + "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz", + "integrity": "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/yargs": { + "version": "17.0.35", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.35.tgz", + "integrity": "sha512-qUHkeCyQFxMXg79wQfTtfndEC+N9ZZg76HJftDJp+qH2tV7Gj4OJi7l+PiWwJ+pWtW8GwSmqsDj/oymhrTWXjg==", + "license": "MIT", + "dependencies": { + "@types/yargs-parser": "*" + } + }, + "node_modules/@types/yargs-parser": { + "version": "21.0.3", + "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", + "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", + "license": "MIT" + }, + "node_modules/@ungap/structured-clone": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", + "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", + "license": "ISC" + }, + "node_modules/@webassemblyjs/ast": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.14.1.tgz", + "integrity": "sha512-nuBEDgQfm1ccRp/8bCQrx1frohyufl4JlbMMZ4P1wpeOfDhF6FQkxZJ1b/e+PLwr6X1Nhw6OLme5usuBWYBvuQ==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/helper-numbers": "1.13.2", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2" + } + }, + "node_modules/@webassemblyjs/floating-point-hex-parser": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.13.2.tgz", + "integrity": "sha512-6oXyTOzbKxGH4steLbLNOu71Oj+C8Lg34n6CqRvqfS2O71BxY6ByfMDRhBytzknj9yGUPVJ1qIKhRlAwO1AovA==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-api-error": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.13.2.tgz", + "integrity": "sha512-U56GMYxy4ZQCbDZd6JuvvNV/WFildOjsaWD3Tzzvmw/mas3cXzRJPMjP83JqEsgSbyrmaGjBfDtV7KDXV9UzFQ==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-buffer": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.14.1.tgz", + "integrity": "sha512-jyH7wtcHiKssDtFPRB+iQdxlDf96m0E39yb0k5uJVhFGleZFoNw1c4aeIcVUPPbXUVJ94wwnMOAqUHyzoEPVMA==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-numbers": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.13.2.tgz", + "integrity": "sha512-FE8aCmS5Q6eQYcV3gI35O4J789wlQA+7JrqTTpJqn5emA4U2hvwJmvFRC0HODS+3Ye6WioDklgd6scJ3+PLnEA==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/floating-point-hex-parser": "1.13.2", + "@webassemblyjs/helper-api-error": "1.13.2", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/helper-wasm-bytecode": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.13.2.tgz", + "integrity": "sha512-3QbLKy93F0EAIXLh0ogEVR6rOubA9AoZ+WRYhNbFyuB70j3dRdwH9g+qXhLAO0kiYGlg3TxDV+I4rQTr/YNXkA==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-wasm-section": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.14.1.tgz", + "integrity": "sha512-ds5mXEqTJ6oxRoqjhWDU83OgzAYjwsCV8Lo/N+oRsNDmx/ZDpqalmrtgOMkHwxsG0iI//3BwWAErYRHtgn0dZw==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/wasm-gen": "1.14.1" + } + }, + "node_modules/@webassemblyjs/ieee754": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.13.2.tgz", + "integrity": "sha512-4LtOzh58S/5lX4ITKxnAK2USuNEvpdVV9AlgGQb8rJDHaLeHciwG4zlGr0j/SNWlr7x3vO1lDEsuePvtcDNCkw==", + "license": "MIT", + "dependencies": { + "@xtuc/ieee754": "^1.2.0" + } + }, + "node_modules/@webassemblyjs/leb128": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.13.2.tgz", + "integrity": "sha512-Lde1oNoIdzVzdkNEAWZ1dZ5orIbff80YPdHx20mrHwHrVNNTjNr8E3xz9BdpcGqRQbAEa+fkrCb+fRFTl/6sQw==", + "license": "Apache-2.0", + "dependencies": { + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/utf8": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.13.2.tgz", + "integrity": "sha512-3NQWGjKTASY1xV5m7Hr0iPeXD9+RDobLll3T9d2AO+g3my8xy5peVyjSag4I50mR1bBSN/Ct12lo+R9tJk0NZQ==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/wasm-edit": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.14.1.tgz", + "integrity": "sha512-RNJUIQH/J8iA/1NzlE4N7KtyZNHi3w7at7hDjvRNm5rcUXa00z1vRz3glZoULfJ5mpvYhLybmVcwcjGrC1pRrQ==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/helper-wasm-section": "1.14.1", + "@webassemblyjs/wasm-gen": "1.14.1", + "@webassemblyjs/wasm-opt": "1.14.1", + "@webassemblyjs/wasm-parser": "1.14.1", + "@webassemblyjs/wast-printer": "1.14.1" + } + }, + "node_modules/@webassemblyjs/wasm-gen": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.14.1.tgz", + "integrity": "sha512-AmomSIjP8ZbfGQhumkNvgC33AY7qtMCXnN6bL2u2Js4gVCg8fp735aEiMSBbDR7UQIj90n4wKAFUSEd0QN2Ukg==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/ieee754": "1.13.2", + "@webassemblyjs/leb128": "1.13.2", + "@webassemblyjs/utf8": "1.13.2" + } + }, + "node_modules/@webassemblyjs/wasm-opt": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.14.1.tgz", + "integrity": "sha512-PTcKLUNvBqnY2U6E5bdOQcSM+oVP/PmrDY9NzowJjislEjwP/C4an2303MCVS2Mg9d3AJpIGdUFIQQWbPds0Sw==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/wasm-gen": "1.14.1", + "@webassemblyjs/wasm-parser": "1.14.1" + } + }, + "node_modules/@webassemblyjs/wasm-parser": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.14.1.tgz", + "integrity": "sha512-JLBl+KZ0R5qB7mCnud/yyX08jWFw5MsoalJ1pQ4EdFlgj9VdXKGuENGsiCIjegI1W7p91rUlcB/LB5yRJKNTcQ==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-api-error": "1.13.2", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/ieee754": "1.13.2", + "@webassemblyjs/leb128": "1.13.2", + "@webassemblyjs/utf8": "1.13.2" + } + }, + "node_modules/@webassemblyjs/wast-printer": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.14.1.tgz", + "integrity": "sha512-kPSSXE6De1XOR820C90RIo2ogvZG+c3KiHzqUoO/F34Y2shGzesfqv7o57xrxovZJH/MetF5UjroJ/R/3isoiw==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@xtuc/ieee754": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", + "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==", + "license": "BSD-3-Clause" + }, + "node_modules/@xtuc/long": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", + "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==", + "license": "Apache-2.0" + }, + "node_modules/accepts": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", + "license": "MIT", + "dependencies": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/negotiator": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/acorn": { + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", + "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-import-phases": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz", + "integrity": "sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ==", + "license": "MIT", + "engines": { + "node": ">=10.13.0" + }, + "peerDependencies": { + "acorn": "^8.14.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "license": "MIT", + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.3.5", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.5.tgz", + "integrity": "sha512-HEHNfbars9v4pgpW6SO1KSPkfoS0xVOM/9UzkJltjlsHZmJasxg8aXkuZa7SMf8vKGIBhpUsPluQSqhJFCqebw==", + "license": "MIT", + "dependencies": { + "acorn": "^8.11.0" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/address": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/address/-/address-1.2.2.tgz", + "integrity": "sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA==", + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/aggregate-error": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", + "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", + "license": "MIT", + "dependencies": { + "clean-stack": "^2.0.0", + "indent-string": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ajv": { + "version": "8.18.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", + "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-formats": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz", + "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==", + "license": "MIT", + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ajv-keywords": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-5.1.0.tgz", + "integrity": "sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3" + }, + "peerDependencies": { + "ajv": "^8.8.2" + } + }, + "node_modules/algoliasearch": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.50.0.tgz", + "integrity": "sha512-yE5I83Q2s8euVou8Y3feXK08wyZInJWLYXgWO6Xti9jBUEZAGUahyeQ7wSZWkifLWVnQVKEz5RAmBlXG5nqxog==", + "license": "MIT", + "dependencies": { + "@algolia/abtesting": "1.16.0", + "@algolia/client-abtesting": "5.50.0", + "@algolia/client-analytics": "5.50.0", + "@algolia/client-common": "5.50.0", + "@algolia/client-insights": "5.50.0", + "@algolia/client-personalization": "5.50.0", + "@algolia/client-query-suggestions": "5.50.0", + "@algolia/client-search": "5.50.0", + "@algolia/ingestion": "1.50.0", + "@algolia/monitoring": "1.50.0", + "@algolia/recommend": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/algoliasearch-helper": { + "version": "3.28.1", + "resolved": "https://registry.npmjs.org/algoliasearch-helper/-/algoliasearch-helper-3.28.1.tgz", + "integrity": "sha512-6iXpbkkrAI5HFpCWXlNmIDSBuoN/U1XnEvb2yJAoWfqrZ+DrybI7MQ5P5mthFaprmocq+zbi6HxnR28xnZAYBw==", + "license": "MIT", + "dependencies": { + "@algolia/events": "^4.0.1" + }, + "peerDependencies": { + "algoliasearch": ">= 3.1 < 6" + } + }, + "node_modules/ansi-align": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", + "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", + "license": "ISC", + "dependencies": { + "string-width": "^4.1.0" + } + }, + "node_modules/ansi-align/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/ansi-align/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-escapes": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", + "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "license": "MIT", + "dependencies": { + "type-fest": "^0.21.3" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-escapes/node_modules/type-fest": { + "version": "0.21.3", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", + "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-html-community": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/ansi-html-community/-/ansi-html-community-0.0.8.tgz", + "integrity": "sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw==", + "engines": [ + "node >= 0.8.0" + ], + "license": "Apache-2.0", + "bin": { + "ansi-html": "bin/ansi-html" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "license": "ISC", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/arg": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", + "integrity": "sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==", + "license": "MIT" + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "node_modules/array-flatten": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", + "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "license": "MIT" + }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/asn1js": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/asn1js/-/asn1js-3.0.7.tgz", + "integrity": "sha512-uLvq6KJu04qoQM6gvBfKFjlh6Gl0vOKQuR5cJMDHQkmwfMOQeN3F3SHCv9SNYSL+CRoHvOGFfllDlVz03GQjvQ==", + "license": "BSD-3-Clause", + "dependencies": { + "pvtsutils": "^1.3.6", + "pvutils": "^1.1.3", + "tslib": "^2.8.1" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/astring": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/astring/-/astring-1.9.0.tgz", + "integrity": "sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg==", + "license": "MIT", + "bin": { + "astring": "bin/astring" + } + }, + "node_modules/autoprefixer": { + "version": "10.4.27", + "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.27.tgz", + "integrity": "sha512-NP9APE+tO+LuJGn7/9+cohklunJsXWiaWEfV3si4Gi/XHDwVNgkwr1J3RQYFIvPy76GmJ9/bW8vyoU1LcxwKHA==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/autoprefixer" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "browserslist": "^4.28.1", + "caniuse-lite": "^1.0.30001774", + "fraction.js": "^5.3.4", + "picocolors": "^1.1.1", + "postcss-value-parser": "^4.2.0" + }, + "bin": { + "autoprefixer": "bin/autoprefixer" + }, + "engines": { + "node": "^10 || ^12 || >=14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/babel-loader": { + "version": "9.2.1", + "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-9.2.1.tgz", + "integrity": "sha512-fqe8naHt46e0yIdkjUZYqddSXfej3AHajX+CSO5X7oy0EmPc6o5Xh+RClNoHjnieWz9AW4kZxW9yyFMhVB1QLA==", + "license": "MIT", + "dependencies": { + "find-cache-dir": "^4.0.0", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0", + "webpack": ">=5" + } + }, + "node_modules/babel-plugin-dynamic-import-node": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/babel-plugin-dynamic-import-node/-/babel-plugin-dynamic-import-node-2.3.3.tgz", + "integrity": "sha512-jZVI+s9Zg3IqA/kdi0i6UDCybUI3aSBLnglhYbSSjKlV7yF1F/5LWv8MakQmvYpnbJDS6fcBL2KzHSxNCMtWSQ==", + "license": "MIT", + "dependencies": { + "object.assign": "^4.1.0" + } + }, + "node_modules/babel-plugin-polyfill-corejs2": { + "version": "0.4.17", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.17.tgz", + "integrity": "sha512-aTyf30K/rqAsNwN76zYrdtx8obu0E4KoUME29B1xj+B3WxgvWkp943vYQ+z8Mv3lw9xHXMHpvSPOBxzAkIa94w==", + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.28.6", + "@babel/helper-define-polyfill-provider": "^0.6.8", + "semver": "^6.3.1" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-polyfill-corejs2/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz", + "integrity": "sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A==", + "license": "MIT", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.5", + "core-js-compat": "^3.43.0" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-polyfill-regenerator": { + "version": "0.6.8", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.8.tgz", + "integrity": "sha512-M762rNHfSF1EV3SLtnCJXFoQbbIIz0OyRwnCmV0KPC7qosSfCO0QLTSuJX3ayAebubhE6oYBAYPrBA5ljowaZg==", + "license": "MIT", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.8" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/bail": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/bail/-/bail-2.0.2.tgz", + "integrity": "sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" + }, + "node_modules/baseline-browser-mapping": { + "version": "2.10.11", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.11.tgz", + "integrity": "sha512-DAKrHphkJyiGuau/cFieRYhcTFeK/lBuD++C7cZ6KZHbMhBrisoi+EvhQ5RZrIfV5qwsW8kgQ07JIC+MDJRAhg==", + "license": "Apache-2.0", + "bin": { + "baseline-browser-mapping": "dist/cli.cjs" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/batch": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/batch/-/batch-0.6.1.tgz", + "integrity": "sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw==", + "license": "MIT" + }, + "node_modules/big.js": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", + "integrity": "sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==", + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/binary-extensions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", + "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/body-parser": { + "version": "1.20.4", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.4.tgz", + "integrity": "sha512-ZTgYYLMOXY9qKU/57FAo8F+HA2dGX7bqGc71txDRC1rS4frdFI5R7NhluHxH6M0YItAP0sHB4uqAOcYKxO6uGA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "content-type": "~1.0.5", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "~1.2.0", + "http-errors": "~2.0.1", + "iconv-lite": "~0.4.24", + "on-finished": "~2.4.1", + "qs": "~6.14.0", + "raw-body": "~2.5.3", + "type-is": "~1.6.18", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/body-parser/node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/body-parser/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/body-parser/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/bonjour-service": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/bonjour-service/-/bonjour-service-1.3.0.tgz", + "integrity": "sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "multicast-dns": "^7.2.5" + } + }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==", + "license": "ISC" + }, + "node_modules/boxen": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-6.2.1.tgz", + "integrity": "sha512-H4PEsJXfFI/Pt8sjDWbHlQPx4zL/bvSQjcilJmaulGt5mLDorHOHpmdXAJcBcmru7PhYSp/cDMWRko4ZUMFkSw==", + "license": "MIT", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^6.2.0", + "chalk": "^4.1.2", + "cli-boxes": "^3.0.0", + "string-width": "^5.0.1", + "type-fest": "^2.5.0", + "widest-line": "^4.0.1", + "wrap-ansi": "^8.0.1" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/brace-expansion": { + "version": "1.1.12", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", + "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browserslist": { + "version": "4.28.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz", + "integrity": "sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "baseline-browser-mapping": "^2.9.0", + "caniuse-lite": "^1.0.30001759", + "electron-to-chromium": "^1.5.263", + "node-releases": "^2.0.27", + "update-browserslist-db": "^1.2.0" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "license": "MIT" + }, + "node_modules/bundle-name": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/bundle-name/-/bundle-name-4.1.0.tgz", + "integrity": "sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q==", + "license": "MIT", + "dependencies": { + "run-applescript": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/bytes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", + "integrity": "sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/bytestreamjs": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/bytestreamjs/-/bytestreamjs-2.0.1.tgz", + "integrity": "sha512-U1Z/ob71V/bXfVABvNr/Kumf5VyeQRBEm6Txb0PQ6S7V5GpBM3w4Cbqz/xPDicR5tN0uvDifng8C+5qECeGwyQ==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/cacheable-lookup": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz", + "integrity": "sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w==", + "license": "MIT", + "engines": { + "node": ">=14.16" + } + }, + "node_modules/cacheable-request": { + "version": "10.2.14", + "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-10.2.14.tgz", + "integrity": "sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ==", + "license": "MIT", + "dependencies": { + "@types/http-cache-semantics": "^4.0.2", + "get-stream": "^6.0.1", + "http-cache-semantics": "^4.1.1", + "keyv": "^4.5.3", + "mimic-response": "^4.0.0", + "normalize-url": "^8.0.0", + "responselike": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + } + }, + "node_modules/call-bind": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", + "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.0", + "es-define-property": "^1.0.0", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/camel-case": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", + "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", + "license": "MIT", + "dependencies": { + "pascal-case": "^3.1.2", + "tslib": "^2.0.3" + } + }, + "node_modules/camelcase": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", + "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/caniuse-api": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", + "integrity": "sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.0.0", + "caniuse-lite": "^1.0.0", + "lodash.memoize": "^4.1.2", + "lodash.uniq": "^4.5.0" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001781", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001781.tgz", + "integrity": "sha512-RdwNCyMsNBftLjW6w01z8bKEvT6e/5tpPVEgtn22TiLGlstHOVecsX2KHFkD5e/vRnIE4EGzpuIODb3mtswtkw==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/ccount": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", + "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/char-regex": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", + "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/character-entities": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", + "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-html4": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", + "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-legacy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", + "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-reference-invalid": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz", + "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/cheerio": { + "version": "1.0.0-rc.12", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.12.tgz", + "integrity": "sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==", + "license": "MIT", + "dependencies": { + "cheerio-select": "^2.1.0", + "dom-serializer": "^2.0.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1", + "htmlparser2": "^8.0.1", + "parse5": "^7.0.0", + "parse5-htmlparser2-tree-adapter": "^7.0.0" + }, + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/cheeriojs/cheerio?sponsor=1" + } + }, + "node_modules/cheerio-select": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz", + "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-select": "^5.1.0", + "css-what": "^6.1.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/chokidar": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", + "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", + "license": "MIT", + "dependencies": { + "anymatch": "~3.1.2", + "braces": "~3.0.2", + "glob-parent": "~5.1.2", + "is-binary-path": "~2.1.0", + "is-glob": "~4.0.1", + "normalize-path": "~3.0.0", + "readdirp": "~3.6.0" + }, + "engines": { + "node": ">= 8.10.0" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/chrome-trace-event": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.4.tgz", + "integrity": "sha512-rNjApaLzuwaOTjCiT8lSDdGN1APCiqkChLMJxJPWLunPAt5fy8xgU9/jNOchV84wfIxrA0lRQB7oCT8jrn/wrQ==", + "license": "MIT", + "engines": { + "node": ">=6.0" + } + }, + "node_modules/ci-info": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", + "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/clean-css": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/clean-css/-/clean-css-5.3.3.tgz", + "integrity": "sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg==", + "license": "MIT", + "dependencies": { + "source-map": "~0.6.0" + }, + "engines": { + "node": ">= 10.0" + } + }, + "node_modules/clean-css/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/clean-stack": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", + "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/cli-boxes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/cli-table3": { + "version": "0.6.5", + "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.5.tgz", + "integrity": "sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ==", + "license": "MIT", + "dependencies": { + "string-width": "^4.2.0" + }, + "engines": { + "node": "10.* || >= 12.*" + }, + "optionalDependencies": { + "@colors/colors": "1.5.0" + } + }, + "node_modules/cli-table3/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/cli-table3/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/clone-deep": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", + "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", + "license": "MIT", + "dependencies": { + "is-plain-object": "^2.0.4", + "kind-of": "^6.0.2", + "shallow-clone": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/clsx": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", + "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/collapse-white-space": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-2.1.0.tgz", + "integrity": "sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" + }, + "node_modules/colord": { + "version": "2.9.3", + "resolved": "https://registry.npmjs.org/colord/-/colord-2.9.3.tgz", + "integrity": "sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==", + "license": "MIT" + }, + "node_modules/colorette": { + "version": "2.0.20", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", + "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==", + "license": "MIT" + }, + "node_modules/combine-promises": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/combine-promises/-/combine-promises-1.2.0.tgz", + "integrity": "sha512-VcQB1ziGD0NXrhKxiwyNbCDmRzs/OShMs2GqW2DlU2A/Sd0nQxE1oWDAE5O0ygSx5mgQOn9eIFh7yKPgFRVkPQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/comma-separated-tokens": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", + "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/commander": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz", + "integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==", + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/common-path-prefix": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/common-path-prefix/-/common-path-prefix-3.0.0.tgz", + "integrity": "sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w==", + "license": "ISC" + }, + "node_modules/compressible": { + "version": "2.0.18", + "resolved": "https://registry.npmjs.org/compressible/-/compressible-2.0.18.tgz", + "integrity": "sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg==", + "license": "MIT", + "dependencies": { + "mime-db": ">= 1.43.0 < 2" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/compressible/node_modules/mime-db": { + "version": "1.54.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", + "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/compression": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/compression/-/compression-1.8.1.tgz", + "integrity": "sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w==", + "license": "MIT", + "dependencies": { + "bytes": "3.1.2", + "compressible": "~2.0.18", + "debug": "2.6.9", + "negotiator": "~0.6.4", + "on-headers": "~1.1.0", + "safe-buffer": "5.2.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/compression/node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/compression/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/compression/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "license": "MIT" + }, + "node_modules/config-chain": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", + "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", + "license": "MIT", + "dependencies": { + "ini": "^1.3.4", + "proto-list": "~1.2.1" + } + }, + "node_modules/config-chain/node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "license": "ISC" + }, + "node_modules/configstore": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", + "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", + "license": "BSD-2-Clause", + "dependencies": { + "dot-prop": "^6.0.1", + "graceful-fs": "^4.2.6", + "unique-string": "^3.0.0", + "write-file-atomic": "^3.0.3", + "xdg-basedir": "^5.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/yeoman/configstore?sponsor=1" + } + }, + "node_modules/connect-history-api-fallback": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/connect-history-api-fallback/-/connect-history-api-fallback-2.0.0.tgz", + "integrity": "sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA==", + "license": "MIT", + "engines": { + "node": ">=0.8" + } + }, + "node_modules/consola": { + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/consola/-/consola-3.4.2.tgz", + "integrity": "sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA==", + "license": "MIT", + "engines": { + "node": "^14.18.0 || >=16.10.0" + } + }, + "node_modules/content-disposition": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.2.tgz", + "integrity": "sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/content-type": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", + "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "license": "MIT" + }, + "node_modules/cookie": { + "version": "0.7.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", + "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.7.tgz", + "integrity": "sha512-NXdYc3dLr47pBkpUCHtKSwIOQXLVn8dZEuywboCOJY/osA0wFSLlSawr3KN8qXJEyX66FcONTH8EIlVuK0yyFA==", + "license": "MIT" + }, + "node_modules/copy-webpack-plugin": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz", + "integrity": "sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ==", + "license": "MIT", + "dependencies": { + "fast-glob": "^3.2.11", + "glob-parent": "^6.0.1", + "globby": "^13.1.1", + "normalize-path": "^3.0.0", + "schema-utils": "^4.0.0", + "serialize-javascript": "^6.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + } + }, + "node_modules/copy-webpack-plugin/node_modules/glob-parent": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", + "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.3" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/copy-webpack-plugin/node_modules/globby": { + "version": "13.2.2", + "resolved": "https://registry.npmjs.org/globby/-/globby-13.2.2.tgz", + "integrity": "sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==", + "license": "MIT", + "dependencies": { + "dir-glob": "^3.0.1", + "fast-glob": "^3.3.0", + "ignore": "^5.2.4", + "merge2": "^1.4.1", + "slash": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/copy-webpack-plugin/node_modules/slash": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", + "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/core-js": { + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.49.0.tgz", + "integrity": "sha512-es1U2+YTtzpwkxVLwAFdSpaIMyQaq0PBgm3YD1W3Qpsn1NAmO3KSgZfu+oGSWVu6NvLHoHCV/aYcsE5wiB7ALg==", + "hasInstallScript": true, + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-js-compat": { + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.49.0.tgz", + "integrity": "sha512-VQXt1jr9cBz03b331DFDCCP90b3fanciLkgiOoy8SBHy06gNf+vQ1A3WFLqG7I8TipYIKeYK9wxd0tUrvHcOZA==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.28.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-js-pure": { + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js-pure/-/core-js-pure-3.49.0.tgz", + "integrity": "sha512-XM4RFka59xATyJv/cS3O3Kml72hQXUeGRuuTmMYFxwzc9/7C8OYTaIR/Ji+Yt8DXzsFLNhat15cE/JP15HrCgw==", + "hasInstallScript": true, + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-util-is": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", + "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==", + "license": "MIT" + }, + "node_modules/cosmiconfig": { + "version": "8.3.6", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-8.3.6.tgz", + "integrity": "sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==", + "license": "MIT", + "dependencies": { + "import-fresh": "^3.3.0", + "js-yaml": "^4.1.0", + "parse-json": "^5.2.0", + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/d-fischer" + }, + "peerDependencies": { + "typescript": ">=4.9.5" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/cross-spawn": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/crypto-random-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", + "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", + "license": "MIT", + "dependencies": { + "type-fest": "^1.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/crypto-random-string/node_modules/type-fest": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", + "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/css-blank-pseudo": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/css-blank-pseudo/-/css-blank-pseudo-7.0.1.tgz", + "integrity": "sha512-jf+twWGDf6LDoXDUode+nc7ZlrqfaNphrBIBrcmeP3D8yw1uPaix1gCC8LUQUGQ6CycuK2opkbFFWFuq/a94ag==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/css-blank-pseudo/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/css-declaration-sorter": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/css-declaration-sorter/-/css-declaration-sorter-7.3.1.tgz", + "integrity": "sha512-gz6x+KkgNCjxq3Var03pRYLhyNfwhkKF1g/yoLgDNtFvVu0/fOLV9C8fFEZRjACp/XQLumjAYo7JVjzH3wLbxA==", + "license": "ISC", + "engines": { + "node": "^14 || ^16 || >=18" + }, + "peerDependencies": { + "postcss": "^8.0.9" + } + }, + "node_modules/css-has-pseudo": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/css-has-pseudo/-/css-has-pseudo-7.0.3.tgz", + "integrity": "sha512-oG+vKuGyqe/xvEMoxAQrhi7uY16deJR3i7wwhBerVrGQKSqUC5GiOVxTpM9F9B9hw0J+eKeOWLH7E9gZ1Dr5rA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/selector-specificity": "^5.0.0", + "postcss-selector-parser": "^7.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/css-has-pseudo/node_modules/@csstools/selector-specificity": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", + "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/css-has-pseudo/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/css-loader": { + "version": "6.11.0", + "resolved": "https://registry.npmjs.org/css-loader/-/css-loader-6.11.0.tgz", + "integrity": "sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g==", + "license": "MIT", + "dependencies": { + "icss-utils": "^5.1.0", + "postcss": "^8.4.33", + "postcss-modules-extract-imports": "^3.1.0", + "postcss-modules-local-by-default": "^4.0.5", + "postcss-modules-scope": "^3.2.0", + "postcss-modules-values": "^4.0.0", + "postcss-value-parser": "^4.2.0", + "semver": "^7.5.4" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "@rspack/core": "0.x || 1.x", + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "@rspack/core": { + "optional": true + }, + "webpack": { + "optional": true + } + } + }, + "node_modules/css-minimizer-webpack-plugin": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/css-minimizer-webpack-plugin/-/css-minimizer-webpack-plugin-5.0.1.tgz", + "integrity": "sha512-3caImjKFQkS+ws1TGcFn0V1HyDJFq1Euy589JlD6/3rV2kj+w7r5G9WDMgSHvpvXHNZ2calVypZWuEDQd9wfLg==", + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.18", + "cssnano": "^6.0.1", + "jest-worker": "^29.4.3", + "postcss": "^8.4.24", + "schema-utils": "^4.0.1", + "serialize-javascript": "^6.0.1" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "@parcel/css": { + "optional": true + }, + "@swc/css": { + "optional": true + }, + "clean-css": { + "optional": true + }, + "csso": { + "optional": true + }, + "esbuild": { + "optional": true + }, + "lightningcss": { + "optional": true + } + } + }, + "node_modules/css-prefers-color-scheme": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/css-prefers-color-scheme/-/css-prefers-color-scheme-10.0.0.tgz", + "integrity": "sha512-VCtXZAWivRglTZditUfB4StnsWr6YVZ2PRtuxQLKTNRdtAf8tpzaVPE9zXIF3VaSc7O70iK/j1+NXxyQCqdPjQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/css-select": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.2.2.tgz", + "integrity": "sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.1.0", + "domhandler": "^5.0.2", + "domutils": "^3.0.1", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/css-tree": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.3.1.tgz", + "integrity": "sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw==", + "license": "MIT", + "dependencies": { + "mdn-data": "2.0.30", + "source-map-js": "^1.0.1" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0" + } + }, + "node_modules/css-what": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.2.2.tgz", + "integrity": "sha512-u/O3vwbptzhMs3L1fQE82ZSLHQQfto5gyZzwteVIEyeaY5Fc7R4dapF/BvRoSYFeqfBk4m0V1Vafq5Pjv25wvA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/cssdb": { + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/cssdb/-/cssdb-8.8.0.tgz", + "integrity": "sha512-QbLeyz2Bgso1iRlh7IpWk6OKa3lLNGXsujVjDMPl9rOZpxKeiG69icLpbLCFxeURwmcdIfZqQyhlooKJYM4f8Q==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + }, + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + } + ], + "license": "MIT-0" + }, + "node_modules/cssesc": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", + "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==", + "license": "MIT", + "bin": { + "cssesc": "bin/cssesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/cssnano": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano/-/cssnano-6.1.2.tgz", + "integrity": "sha512-rYk5UeX7VAM/u0lNqewCdasdtPK81CgX8wJFLEIXHbV2oldWRgJAsZrdhRXkV1NJzA2g850KiFm9mMU2HxNxMA==", + "license": "MIT", + "dependencies": { + "cssnano-preset-default": "^6.1.2", + "lilconfig": "^3.1.1" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/cssnano" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-preset-advanced": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano-preset-advanced/-/cssnano-preset-advanced-6.1.2.tgz", + "integrity": "sha512-Nhao7eD8ph2DoHolEzQs5CfRpiEP0xa1HBdnFZ82kvqdmbwVBUr2r1QuQ4t1pi+D1ZpqpcO4T+wy/7RxzJ/WPQ==", + "license": "MIT", + "dependencies": { + "autoprefixer": "^10.4.19", + "browserslist": "^4.23.0", + "cssnano-preset-default": "^6.1.2", + "postcss-discard-unused": "^6.0.5", + "postcss-merge-idents": "^6.0.3", + "postcss-reduce-idents": "^6.0.3", + "postcss-zindex": "^6.0.2" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-preset-default": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano-preset-default/-/cssnano-preset-default-6.1.2.tgz", + "integrity": "sha512-1C0C+eNaeN8OcHQa193aRgYexyJtU8XwbdieEjClw+J9d94E41LwT6ivKH0WT+fYwYWB0Zp3I3IZ7tI/BbUbrg==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "css-declaration-sorter": "^7.2.0", + "cssnano-utils": "^4.0.2", + "postcss-calc": "^9.0.1", + "postcss-colormin": "^6.1.0", + "postcss-convert-values": "^6.1.0", + "postcss-discard-comments": "^6.0.2", + "postcss-discard-duplicates": "^6.0.3", + "postcss-discard-empty": "^6.0.3", + "postcss-discard-overridden": "^6.0.2", + "postcss-merge-longhand": "^6.0.5", + "postcss-merge-rules": "^6.1.1", + "postcss-minify-font-values": "^6.1.0", + "postcss-minify-gradients": "^6.0.3", + "postcss-minify-params": "^6.1.0", + "postcss-minify-selectors": "^6.0.4", + "postcss-normalize-charset": "^6.0.2", + "postcss-normalize-display-values": "^6.0.2", + "postcss-normalize-positions": "^6.0.2", + "postcss-normalize-repeat-style": "^6.0.2", + "postcss-normalize-string": "^6.0.2", + "postcss-normalize-timing-functions": "^6.0.2", + "postcss-normalize-unicode": "^6.1.0", + "postcss-normalize-url": "^6.0.2", + "postcss-normalize-whitespace": "^6.0.2", + "postcss-ordered-values": "^6.0.2", + "postcss-reduce-initial": "^6.1.0", + "postcss-reduce-transforms": "^6.0.2", + "postcss-svgo": "^6.0.3", + "postcss-unique-selectors": "^6.0.4" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-utils": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/cssnano-utils/-/cssnano-utils-4.0.2.tgz", + "integrity": "sha512-ZR1jHg+wZ8o4c3zqf1SIUSTIvm/9mU343FMR6Obe/unskbvpGhZOo1J6d/r8D1pzkRQYuwbcH3hToOuoA2G7oQ==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/csso": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/csso/-/csso-5.0.5.tgz", + "integrity": "sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ==", + "license": "MIT", + "dependencies": { + "css-tree": "~2.2.0" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", + "npm": ">=7.0.0" + } + }, + "node_modules/csso/node_modules/css-tree": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.2.1.tgz", + "integrity": "sha512-OA0mILzGc1kCOCSJerOeqDxDQ4HOh+G8NbOJFOTgOCzpw7fCBubk0fEyxp8AgOL/jvLgYA/uV0cMbe43ElF1JA==", + "license": "MIT", + "dependencies": { + "mdn-data": "2.0.28", + "source-map-js": "^1.0.1" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", + "npm": ">=7.0.0" + } + }, + "node_modules/csso/node_modules/mdn-data": { + "version": "2.0.28", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.28.tgz", + "integrity": "sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g==", + "license": "CC0-1.0" + }, + "node_modules/csstype": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", + "license": "MIT" + }, + "node_modules/debounce": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/debounce/-/debounce-1.2.1.tgz", + "integrity": "sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug==", + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/decode-named-character-reference": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.3.0.tgz", + "integrity": "sha512-GtpQYB283KrPp6nRw50q3U9/VfOutZOe103qlN7BPP6Ad27xYnOIWv4lPzo8HCAL+mMZofJ9KEy30fq6MfaK6Q==", + "license": "MIT", + "dependencies": { + "character-entities": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/decompress-response": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", + "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", + "license": "MIT", + "dependencies": { + "mimic-response": "^3.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/decompress-response/node_modules/mimic-response": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", + "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "license": "MIT", + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/deepmerge": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/default-browser": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/default-browser/-/default-browser-5.5.0.tgz", + "integrity": "sha512-H9LMLr5zwIbSxrmvikGuI/5KGhZ8E2zH3stkMgM5LpOWDutGM2JZaj460Udnf1a+946zc7YBgrqEWwbk7zHvGw==", + "license": "MIT", + "dependencies": { + "bundle-name": "^4.1.0", + "default-browser-id": "^5.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/default-browser-id": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/default-browser-id/-/default-browser-id-5.0.1.tgz", + "integrity": "sha512-x1VCxdX4t+8wVfd1so/9w+vQ4vx7lKd2Qp5tDRutErwmR85OgmfX7RlLRMWafRMY7hbEiXIbudNrjOAPa/hL8Q==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/defer-to-connect": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", + "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-lazy-prop": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", + "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/depd": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", + "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/destroy": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", + "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "license": "MIT", + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/detect-node": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/detect-node/-/detect-node-2.1.0.tgz", + "integrity": "sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g==", + "license": "MIT" + }, + "node_modules/detect-port": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/detect-port/-/detect-port-1.6.1.tgz", + "integrity": "sha512-CmnVc+Hek2egPx1PeTFVta2W78xy2K/9Rkf6cC4T59S50tVnzKj+tnx5mmx5lwvCkujZ4uRrpRSuV+IVs3f90Q==", + "license": "MIT", + "dependencies": { + "address": "^1.0.1", + "debug": "4" + }, + "bin": { + "detect": "bin/detect-port.js", + "detect-port": "bin/detect-port.js" + }, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "license": "MIT", + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "license": "MIT", + "dependencies": { + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/dns-packet": { + "version": "5.6.1", + "resolved": "https://registry.npmjs.org/dns-packet/-/dns-packet-5.6.1.tgz", + "integrity": "sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw==", + "license": "MIT", + "dependencies": { + "@leichtgewicht/ip-codec": "^2.0.1" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/dom-converter": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", + "integrity": "sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA==", + "license": "MIT", + "dependencies": { + "utila": "~0.4" + } + }, + "node_modules/dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/domelementtype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", + "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "BSD-2-Clause" + }, + "node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/domutils": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz", + "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==", + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/dot-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", + "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/dot-prop": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", + "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", + "license": "MIT", + "dependencies": { + "is-obj": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/dot-prop/node_modules/is-obj": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", + "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/duplexer": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", + "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", + "license": "MIT" + }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "license": "MIT" + }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", + "license": "MIT" + }, + "node_modules/electron-to-chromium": { + "version": "1.5.325", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.325.tgz", + "integrity": "sha512-PwfIw7WQSt3xX7yOf5OE/unLzsK9CaN2f/FvV3WjPR1Knoc1T9vePRVV4W1EM301JzzysK51K7FNKcusCr0zYA==", + "license": "ISC" + }, + "node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "license": "MIT" + }, + "node_modules/emojilib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/emojilib/-/emojilib-2.4.0.tgz", + "integrity": "sha512-5U0rVMU5Y2n2+ykNLQqMoqklN9ICBT/KsvC1Gz6vqHbz2AXXGkG+Pm5rMWk/8Vjrr/mY9985Hi8DYzn1F09Nyw==", + "license": "MIT" + }, + "node_modules/emojis-list": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/emojis-list/-/emojis-list-3.0.0.tgz", + "integrity": "sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/emoticon": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/emoticon/-/emoticon-4.1.0.tgz", + "integrity": "sha512-VWZfnxqwNcc51hIy/sbOdEem6D+cVtpPzEEtVAFdaas30+1dgkyaOQ4sQ6Bp0tOMqWO1v+HQfYaoodOkdhK6SQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/encodeurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz", + "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/enhanced-resolve": { + "version": "5.20.1", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.20.1.tgz", + "integrity": "sha512-Qohcme7V1inbAfvjItgw0EaxVX5q2rdVEZHRBrEQdRZTssLDGsL8Lwrznl8oQ/6kuTJONLaDcGjkNP247XEhcA==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.4", + "tapable": "^2.3.0" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/error-ex": { + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.4.tgz", + "integrity": "sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ==", + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-module-lexer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.0.0.tgz", + "integrity": "sha512-5POEcUuZybH7IdmGsD8wlf0AI55wMecM9rVBTI/qEAy2c1kTOm3DjFYjrBdI2K3BaJjJYfYFeRtM0t9ssnRuxw==", + "license": "MIT" + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/esast-util-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz", + "integrity": "sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/esast-util-from-js": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/esast-util-from-js/-/esast-util-from-js-2.0.1.tgz", + "integrity": "sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "acorn": "^8.0.0", + "esast-util-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-goat": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", + "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", + "license": "MIT" + }, + "node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "license": "BSD-2-Clause", + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "license": "BSD-2-Clause", + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esrecurse/node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estree-util-attach-comments": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz", + "integrity": "sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-build-jsx": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/estree-util-build-jsx/-/estree-util-build-jsx-3.0.1.tgz", + "integrity": "sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-walker": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-is-identifier-name": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz", + "integrity": "sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-scope": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/estree-util-scope/-/estree-util-scope-1.0.0.tgz", + "integrity": "sha512-2CAASclonf+JFWBNJPndcOpA8EMJwa0Q8LUFJEKqXLW6+qBvbFZuF5gItbQOs/umBUkjviCSDCbBwU2cXbmrhQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-to-js": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-to-js/-/estree-util-to-js-2.0.0.tgz", + "integrity": "sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "astring": "^1.8.0", + "source-map": "^0.7.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-value-to-estree": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.5.0.tgz", + "integrity": "sha512-aMV56R27Gv3QmfmF1MY12GWkGzzeAezAX+UplqHVASfjc9wNzI/X6hC0S9oxq61WT4aQesLGslWP9tKk6ghRZQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/remcohaszing" + } + }, + "node_modules/estree-util-visit": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-2.0.0.tgz", + "integrity": "sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eta": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/eta/-/eta-2.2.0.tgz", + "integrity": "sha512-UVQ72Rqjy/ZKQalzV5dCCJP80GrmPrMxh6NlNf+erV6ObL0ZFkhCstWRawS85z3smdr3d2wXPsZEY7rDPfGd2g==", + "license": "MIT", + "engines": { + "node": ">=6.0.0" + }, + "funding": { + "url": "https://github.com/eta-dev/eta?sponsor=1" + } + }, + "node_modules/etag": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", + "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/eval": { + "version": "0.1.8", + "resolved": "https://registry.npmjs.org/eval/-/eval-0.1.8.tgz", + "integrity": "sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw==", + "dependencies": { + "@types/node": "*", + "require-like": ">= 0.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/eventemitter3": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", + "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", + "license": "MIT" + }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "license": "MIT", + "engines": { + "node": ">=0.8.x" + } + }, + "node_modules/execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "license": "MIT", + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/express": { + "version": "4.22.1", + "resolved": "https://registry.npmjs.org/express/-/express-4.22.1.tgz", + "integrity": "sha512-F2X8g9P1X7uCPZMA3MVf9wcTqlyNp7IhH5qPCI0izhaOIYXaW9L535tGA3qmjRzpH+bZczqq7hVKxTR4NWnu+g==", + "license": "MIT", + "dependencies": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "~1.20.3", + "content-disposition": "~0.5.4", + "content-type": "~1.0.4", + "cookie": "~0.7.1", + "cookie-signature": "~1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "~1.3.1", + "fresh": "~0.5.2", + "http-errors": "~2.0.0", + "merge-descriptors": "1.0.3", + "methods": "~1.1.2", + "on-finished": "~2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "~0.1.12", + "proxy-addr": "~2.0.7", + "qs": "~6.14.0", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "~0.19.0", + "serve-static": "~1.16.2", + "setprototypeof": "1.2.0", + "statuses": "~2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/express/node_modules/content-disposition": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", + "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", + "license": "MIT", + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/express/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/express/node_modules/path-to-regexp": { + "version": "0.1.13", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.13.tgz", + "integrity": "sha512-A/AGNMFN3c8bOlvV9RreMdrv7jsmF9XIfDeCd87+I8RNg6s78BhJxMu69NEMHBSJFxKidViTEdruRwEk/WIKqA==", + "license": "MIT" + }, + "node_modules/express/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "license": "MIT" + }, + "node_modules/extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", + "license": "MIT", + "dependencies": { + "is-extendable": "^0.1.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "license": "MIT" + }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "license": "MIT" + }, + "node_modules/fast-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", + "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/fastq": { + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fault": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/fault/-/fault-2.0.1.tgz", + "integrity": "sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ==", + "license": "MIT", + "dependencies": { + "format": "^0.2.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/faye-websocket": { + "version": "0.11.4", + "resolved": "https://registry.npmjs.org/faye-websocket/-/faye-websocket-0.11.4.tgz", + "integrity": "sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g==", + "license": "Apache-2.0", + "dependencies": { + "websocket-driver": ">=0.5.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/feed": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/feed/-/feed-4.2.2.tgz", + "integrity": "sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ==", + "license": "MIT", + "dependencies": { + "xml-js": "^1.6.11" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/figures": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", + "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", + "license": "MIT", + "dependencies": { + "escape-string-regexp": "^1.0.5" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/figures/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "license": "MIT", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/file-loader": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/file-loader/-/file-loader-6.2.0.tgz", + "integrity": "sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw==", + "license": "MIT", + "dependencies": { + "loader-utils": "^2.0.0", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/file-loader/node_modules/ajv": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", + "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/file-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "license": "MIT", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/file-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "license": "MIT" + }, + "node_modules/file-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/finalhandler": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.2.tgz", + "integrity": "sha512-aA4RyPcd3badbdABGDuTXCMTtOneUCAYH/gxoYRTZlIJdF0YPWuGqiAsIrhNnnqdXGswYk6dGujem4w80UJFhg==", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "on-finished": "~2.4.1", + "parseurl": "~1.3.3", + "statuses": "~2.0.2", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/finalhandler/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/finalhandler/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/find-cache-dir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-4.0.0.tgz", + "integrity": "sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg==", + "license": "MIT", + "dependencies": { + "common-path-prefix": "^3.0.0", + "pkg-dir": "^7.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/find-up": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-6.3.0.tgz", + "integrity": "sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw==", + "license": "MIT", + "dependencies": { + "locate-path": "^7.1.0", + "path-exists": "^5.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/flat": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/flat/-/flat-5.0.2.tgz", + "integrity": "sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==", + "license": "BSD-3-Clause", + "bin": { + "flat": "cli.js" + } + }, + "node_modules/follow-redirects": { + "version": "1.15.11", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.11.tgz", + "integrity": "sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "license": "MIT", + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/form-data-encoder": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-2.1.4.tgz", + "integrity": "sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw==", + "license": "MIT", + "engines": { + "node": ">= 14.17" + } + }, + "node_modules/format": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz", + "integrity": "sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww==", + "engines": { + "node": ">=0.4.x" + } + }, + "node_modules/forwarded": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", + "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fraction.js": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/fraction.js/-/fraction.js-5.3.4.tgz", + "integrity": "sha512-1X1NTtiJphryn/uLQz3whtY6jK3fTqoE3ohKs0tT+Ujr1W59oopxmoEh7Lu5p6vBaPbgoM0bzveAW4Qi5RyWDQ==", + "license": "MIT", + "engines": { + "node": "*" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/rawify" + } + }, + "node_modules/fresh": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fs-extra": { + "version": "11.3.4", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.4.tgz", + "integrity": "sha512-CTXd6rk/M3/ULNQj8FBqBWHYBVYybQ3VPBw0xGKFe3tuH7ytT6ACnvzpIQ3UZtB8yvUKC2cXn1a+x+5EVQLovA==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=14.14" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-own-enumerable-property-symbols": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz", + "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==", + "license": "ISC" + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/get-stream": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", + "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/github-slugger": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.5.0.tgz", + "integrity": "sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw==", + "license": "ISC" + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/glob-to-regex.js": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/glob-to-regex.js/-/glob-to-regex.js-1.2.0.tgz", + "integrity": "sha512-QMwlOQKU/IzqMUOAZWubUOT8Qft+Y0KQWnX9nK3ch0CJg0tTp4TvGZsTfudYKv2NzoQSyPcnA6TYeIQ3jGichQ==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/glob-to-regexp": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", + "integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==", + "license": "BSD-2-Clause" + }, + "node_modules/global-dirs": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.1.tgz", + "integrity": "sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA==", + "license": "MIT", + "dependencies": { + "ini": "2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "license": "MIT", + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/got": { + "version": "12.6.1", + "resolved": "https://registry.npmjs.org/got/-/got-12.6.1.tgz", + "integrity": "sha512-mThBblvlAF1d4O5oqyvN+ZxLAYwIJK7bpMxgYqPD9okW0C3qm5FFn7k811QrcuEBwaogR3ngOFoCfs6mRv7teQ==", + "license": "MIT", + "dependencies": { + "@sindresorhus/is": "^5.2.0", + "@szmarczak/http-timer": "^5.0.1", + "cacheable-lookup": "^7.0.0", + "cacheable-request": "^10.2.8", + "decompress-response": "^6.0.0", + "form-data-encoder": "^2.1.2", + "get-stream": "^6.0.1", + "http2-wrapper": "^2.1.10", + "lowercase-keys": "^3.0.0", + "p-cancelable": "^3.0.0", + "responselike": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sindresorhus/got?sponsor=1" + } + }, + "node_modules/got/node_modules/@sindresorhus/is": { + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-5.6.0.tgz", + "integrity": "sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sindresorhus/is?sponsor=1" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "license": "ISC" + }, + "node_modules/gray-matter": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/gray-matter/-/gray-matter-4.0.3.tgz", + "integrity": "sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q==", + "license": "MIT", + "dependencies": { + "js-yaml": "^3.13.1", + "kind-of": "^6.0.2", + "section-matter": "^1.0.0", + "strip-bom-string": "^1.0.0" + }, + "engines": { + "node": ">=6.0" + } + }, + "node_modules/gray-matter/node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/gray-matter/node_modules/js-yaml": { + "version": "3.14.2", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz", + "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==", + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/gzip-size": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/gzip-size/-/gzip-size-6.0.0.tgz", + "integrity": "sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==", + "license": "MIT", + "dependencies": { + "duplexer": "^0.1.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/handle-thing": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/handle-thing/-/handle-thing-2.0.1.tgz", + "integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==", + "license": "MIT" + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-yarn": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", + "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/hast-util-from-parse5": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/hast-util-from-parse5/-/hast-util-from-parse5-8.0.3.tgz", + "integrity": "sha512-3kxEVkEKt0zvcZ3hCRYI8rqrgwtlIOFMWkbclACvjlDw8Li9S2hk/d51OI0nr/gIpdMHNepwgOKqZ/sy0Clpyg==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "hastscript": "^9.0.0", + "property-information": "^7.0.0", + "vfile": "^6.0.0", + "vfile-location": "^5.0.0", + "web-namespaces": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-parse-selector": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz", + "integrity": "sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-raw": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/hast-util-raw/-/hast-util-raw-9.1.0.tgz", + "integrity": "sha512-Y8/SBAHkZGoNkpzqqfCldijcuUKh7/su31kEBp67cFY09Wy0mTRgtsLYsiIxMJxlu0f6AA5SUTbDR8K0rxnbUw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "@ungap/structured-clone": "^1.0.0", + "hast-util-from-parse5": "^8.0.0", + "hast-util-to-parse5": "^8.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "parse5": "^7.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-estree": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz", + "integrity": "sha512-48+B/rJWAp0jamNbAAf9M7Uf//UVqAoMmgXhBdxTDJLGKY+LRnZ99qcG+Qjl5HfMpYNzS5v4EAwVEF34LeAj7w==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-attach-comments": "^3.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-jsx-runtime": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz", + "integrity": "sha512-zl6s8LwNyo1P9uw+XJGvZtdFF1GdAkOg8ujOw+4Pyb76874fLps4ueHXDhXWdk6YHQ6OgUtinliG7RsYvCbbBg==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-parse5": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/hast-util-to-parse5/-/hast-util-to-parse5-8.0.1.tgz", + "integrity": "sha512-MlWT6Pjt4CG9lFCjiz4BH7l9wmrMkfkJYCxFwKQic8+RTZgWPuWxwAfjJElsXkex7DJjfSJsQIt931ilUgmwdA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-whitespace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", + "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hastscript": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-9.0.1.tgz", + "integrity": "sha512-g7df9rMFX/SPi34tyGCyUBREQoKkapwdY/T04Qn9TDWfHhAYt4/I0gMVirzK5wEzeUqIjEB+LXC/ypb7Aqno5w==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-parse-selector": "^4.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/he": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", + "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", + "license": "MIT", + "bin": { + "he": "bin/he" + } + }, + "node_modules/history": { + "version": "4.10.1", + "resolved": "https://registry.npmjs.org/history/-/history-4.10.1.tgz", + "integrity": "sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.1.2", + "loose-envify": "^1.2.0", + "resolve-pathname": "^3.0.0", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0", + "value-equal": "^1.0.1" + } + }, + "node_modules/hoist-non-react-statics": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz", + "integrity": "sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==", + "license": "BSD-3-Clause", + "dependencies": { + "react-is": "^16.7.0" + } + }, + "node_modules/hpack.js": { + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/hpack.js/-/hpack.js-2.1.6.tgz", + "integrity": "sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ==", + "license": "MIT", + "dependencies": { + "inherits": "^2.0.1", + "obuf": "^1.0.0", + "readable-stream": "^2.0.1", + "wbuf": "^1.1.0" + } + }, + "node_modules/hpack.js/node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "license": "MIT" + }, + "node_modules/hpack.js/node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "license": "MIT", + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "node_modules/hpack.js/node_modules/safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "license": "MIT" + }, + "node_modules/hpack.js/node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "license": "MIT" + }, + "node_modules/html-minifier-terser": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-7.2.0.tgz", + "integrity": "sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA==", + "license": "MIT", + "dependencies": { + "camel-case": "^4.1.2", + "clean-css": "~5.3.2", + "commander": "^10.0.0", + "entities": "^4.4.0", + "param-case": "^3.0.4", + "relateurl": "^0.2.7", + "terser": "^5.15.1" + }, + "bin": { + "html-minifier-terser": "cli.js" + }, + "engines": { + "node": "^14.13.1 || >=16.0.0" + } + }, + "node_modules/html-minifier-terser/node_modules/commander": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz", + "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", + "license": "MIT", + "engines": { + "node": ">=14" + } + }, + "node_modules/html-tags": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/html-tags/-/html-tags-3.3.1.tgz", + "integrity": "sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/html-void-elements": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", + "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/html-webpack-plugin": { + "version": "5.6.6", + "resolved": "https://registry.npmjs.org/html-webpack-plugin/-/html-webpack-plugin-5.6.6.tgz", + "integrity": "sha512-bLjW01UTrvoWTJQL5LsMRo1SypHW80FTm12OJRSnr3v6YHNhfe+1r0MYUZJMACxnCHURVnBWRwAsWs2yPU9Ezw==", + "license": "MIT", + "dependencies": { + "@types/html-minifier-terser": "^6.0.0", + "html-minifier-terser": "^6.0.2", + "lodash": "^4.17.21", + "pretty-error": "^4.0.0", + "tapable": "^2.0.0" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/html-webpack-plugin" + }, + "peerDependencies": { + "@rspack/core": "0.x || 1.x", + "webpack": "^5.20.0" + }, + "peerDependenciesMeta": { + "@rspack/core": { + "optional": true + }, + "webpack": { + "optional": true + } + } + }, + "node_modules/html-webpack-plugin/node_modules/commander": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", + "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==", + "license": "MIT", + "engines": { + "node": ">= 12" + } + }, + "node_modules/html-webpack-plugin/node_modules/html-minifier-terser": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", + "integrity": "sha512-YXxSlJBZTP7RS3tWnQw74ooKa6L9b9i9QYXY21eUEvhZ3u9XLfv6OnFsQq6RxkhHygsaUMvYsZRV5rU/OVNZxw==", + "license": "MIT", + "dependencies": { + "camel-case": "^4.1.2", + "clean-css": "^5.2.2", + "commander": "^8.3.0", + "he": "^1.2.0", + "param-case": "^3.0.4", + "relateurl": "^0.2.7", + "terser": "^5.10.0" + }, + "bin": { + "html-minifier-terser": "cli.js" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/htmlparser2": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-8.0.2.tgz", + "integrity": "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1", + "entities": "^4.4.0" + } + }, + "node_modules/http-cache-semantics": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", + "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==", + "license": "BSD-2-Clause" + }, + "node_modules/http-deceiver": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/http-deceiver/-/http-deceiver-1.2.7.tgz", + "integrity": "sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw==", + "license": "MIT" + }, + "node_modules/http-errors": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", + "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", + "license": "MIT", + "dependencies": { + "depd": "~2.0.0", + "inherits": "~2.0.4", + "setprototypeof": "~1.2.0", + "statuses": "~2.0.2", + "toidentifier": "~1.0.1" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/http-parser-js": { + "version": "0.5.10", + "resolved": "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.5.10.tgz", + "integrity": "sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA==", + "license": "MIT" + }, + "node_modules/http-proxy": { + "version": "1.18.1", + "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.18.1.tgz", + "integrity": "sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==", + "license": "MIT", + "dependencies": { + "eventemitter3": "^4.0.0", + "follow-redirects": "^1.0.0", + "requires-port": "^1.0.0" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/http-proxy-middleware": { + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz", + "integrity": "sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q==", + "license": "MIT", + "dependencies": { + "@types/http-proxy": "^1.17.8", + "http-proxy": "^1.18.1", + "is-glob": "^4.0.1", + "is-plain-obj": "^3.0.0", + "micromatch": "^4.0.2" + }, + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "@types/express": "^4.17.13" + }, + "peerDependenciesMeta": { + "@types/express": { + "optional": true + } + } + }, + "node_modules/http-proxy-middleware/node_modules/is-plain-obj": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-3.0.0.tgz", + "integrity": "sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/http2-wrapper": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.2.1.tgz", + "integrity": "sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ==", + "license": "MIT", + "dependencies": { + "quick-lru": "^5.1.1", + "resolve-alpn": "^1.2.0" + }, + "engines": { + "node": ">=10.19.0" + } + }, + "node_modules/human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.17.0" + } + }, + "node_modules/hyperdyperid": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/hyperdyperid/-/hyperdyperid-1.2.0.tgz", + "integrity": "sha512-Y93lCzHYgGWdrJ66yIktxiaGULYc6oGiABxhcO5AufBeOyoIdZF7bIfLaOrbM0iGIOXQQgxxRrFEnb+Y6w1n4A==", + "license": "MIT", + "engines": { + "node": ">=10.18" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/icss-utils": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/icss-utils/-/icss-utils-5.1.0.tgz", + "integrity": "sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA==", + "license": "ISC", + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/ignore": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/image-size": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/image-size/-/image-size-2.0.2.tgz", + "integrity": "sha512-IRqXKlaXwgSMAMtpNzZa1ZAe8m+Sa1770Dhk8VkSsP9LS+iHD62Zd8FQKs8fbPiagBE7BzoFX23cxFnwshpV6w==", + "license": "MIT", + "bin": { + "image-size": "bin/image-size.js" + }, + "engines": { + "node": ">=16.x" + } + }, + "node_modules/import-fresh": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", + "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", + "license": "MIT", + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "license": "MIT", + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/indent-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", + "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/infima": { + "version": "0.2.0-alpha.45", + "resolved": "https://registry.npmjs.org/infima/-/infima-0.2.0-alpha.45.tgz", + "integrity": "sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw==", + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" + }, + "node_modules/ini": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", + "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/inline-style-parser": { + "version": "0.2.7", + "resolved": "https://registry.npmjs.org/inline-style-parser/-/inline-style-parser-0.2.7.tgz", + "integrity": "sha512-Nb2ctOyNR8DqQoR0OwRG95uNWIC0C1lCgf5Naz5H6Ji72KZ8OcFZLz2P5sNgwlyoJ8Yif11oMuYs5pBQa86csA==", + "license": "MIT" + }, + "node_modules/invariant": { + "version": "2.2.4", + "resolved": "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz", + "integrity": "sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA==", + "license": "MIT", + "dependencies": { + "loose-envify": "^1.0.0" + } + }, + "node_modules/ipaddr.js": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-2.3.0.tgz", + "integrity": "sha512-Zv/pA+ciVFbCSBBjGfaKUya/CcGmUHzTydLMaTwrUUEM2DIEO3iZvueGxmacvmN50fGpGVKeTXpb2LcYQxeVdg==", + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, + "node_modules/is-alphabetical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", + "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-alphanumerical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz", + "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==", + "license": "MIT", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", + "license": "MIT" + }, + "node_modules/is-binary-path": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", + "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "license": "MIT", + "dependencies": { + "binary-extensions": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-ci": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", + "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", + "license": "MIT", + "dependencies": { + "ci-info": "^3.2.0" + }, + "bin": { + "is-ci": "bin.js" + } + }, + "node_modules/is-core-module": { + "version": "2.16.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", + "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", + "license": "MIT", + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-decimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", + "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-docker": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", + "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==", + "license": "MIT", + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-extendable": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", + "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-hexadecimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", + "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-inside-container": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-inside-container/-/is-inside-container-1.0.0.tgz", + "integrity": "sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==", + "license": "MIT", + "dependencies": { + "is-docker": "^3.0.0" + }, + "bin": { + "is-inside-container": "cli.js" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-inside-container/node_modules/is-docker": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", + "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", + "license": "MIT", + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-installed-globally": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", + "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", + "license": "MIT", + "dependencies": { + "global-dirs": "^3.0.0", + "is-path-inside": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-network-error": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/is-network-error/-/is-network-error-1.3.1.tgz", + "integrity": "sha512-6QCxa49rQbmUWLfk0nuGqzql9U8uaV2H6279bRErPBHe/109hCzsLUBUHfbEtvLIHBd6hyXbgedBSHevm43Edw==", + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-npm": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.1.0.tgz", + "integrity": "sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-obj": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", + "integrity": "sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-path-inside": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-plain-obj": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", + "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-plain-object": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", + "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", + "license": "MIT", + "dependencies": { + "isobject": "^3.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-regexp": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", + "integrity": "sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", + "license": "MIT" + }, + "node_modules/is-wsl": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", + "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==", + "license": "MIT", + "dependencies": { + "is-docker": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-yarn-global": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.1.tgz", + "integrity": "sha512-/kppl+R+LO5VmhYSEWARUFjodS25D68gvj8W7z0I7OWhUla5xWu8KL6CtB2V0R6yqhnRgbcaREMr4EEM6htLPQ==", + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/isarray": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", + "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==", + "license": "MIT" + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "license": "ISC" + }, + "node_modules/isobject": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", + "integrity": "sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/jest-util": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.7.0.tgz", + "integrity": "sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==", + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "@types/node": "*", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "graceful-fs": "^4.2.9", + "picomatch": "^2.2.3" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-worker": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.7.0.tgz", + "integrity": "sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==", + "license": "MIT", + "dependencies": { + "@types/node": "*", + "jest-util": "^29.7.0", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-worker/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/jiti": { + "version": "1.21.7", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.7.tgz", + "integrity": "sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A==", + "license": "MIT", + "bin": { + "jiti": "bin/jiti.js" + } + }, + "node_modules/joi": { + "version": "17.13.3", + "resolved": "https://registry.npmjs.org/joi/-/joi-17.13.3.tgz", + "integrity": "sha512-otDA4ldcIx+ZXsKHWmp0YizCweVRZG96J10b0FevjfuncLO1oX59THoAmHkNubYJ+9gWsYsp5k8v4ib6oDv1fA==", + "license": "BSD-3-Clause", + "dependencies": { + "@hapi/hoek": "^9.3.0", + "@hapi/topo": "^5.1.0", + "@sideway/address": "^4.1.5", + "@sideway/formula": "^3.0.1", + "@sideway/pinpoint": "^2.0.0" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "license": "MIT" + }, + "node_modules/js-yaml": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsesc": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", + "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", + "license": "MIT", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/json-buffer": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", + "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", + "license": "MIT" + }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "license": "MIT" + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "license": "MIT", + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/jsonfile": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", + "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "license": "MIT", + "dependencies": { + "json-buffer": "3.0.1" + } + }, + "node_modules/kind-of": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", + "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/kleur": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", + "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/latest-version": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", + "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", + "license": "MIT", + "dependencies": { + "package-json": "^8.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/launch-editor": { + "version": "2.13.2", + "resolved": "https://registry.npmjs.org/launch-editor/-/launch-editor-2.13.2.tgz", + "integrity": "sha512-4VVDnbOpLXy/s8rdRCSXb+zfMeFR0WlJWpET1iA9CQdlZDfwyLjUuGQzXU4VeOoey6AicSAluWan7Etga6Kcmg==", + "license": "MIT", + "dependencies": { + "picocolors": "^1.1.1", + "shell-quote": "^1.8.3" + } + }, + "node_modules/leven": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", + "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/lilconfig": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.3.tgz", + "integrity": "sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/antonk52" + } + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "license": "MIT" + }, + "node_modules/loader-runner": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.1.tgz", + "integrity": "sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q==", + "license": "MIT", + "engines": { + "node": ">=6.11.5" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/loader-utils": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.4.tgz", + "integrity": "sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw==", + "license": "MIT", + "dependencies": { + "big.js": "^5.2.2", + "emojis-list": "^3.0.0", + "json5": "^2.1.2" + }, + "engines": { + "node": ">=8.9.0" + } + }, + "node_modules/locate-path": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-7.2.0.tgz", + "integrity": "sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA==", + "license": "MIT", + "dependencies": { + "p-locate": "^6.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lodash": { + "version": "4.17.23", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", + "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", + "license": "MIT" + }, + "node_modules/lodash.debounce": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", + "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==", + "license": "MIT" + }, + "node_modules/lodash.memoize": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", + "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==", + "license": "MIT" + }, + "node_modules/lodash.uniq": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.uniq/-/lodash.uniq-4.5.0.tgz", + "integrity": "sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==", + "license": "MIT" + }, + "node_modules/longest-streak": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-3.1.0.tgz", + "integrity": "sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "license": "MIT", + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, + "node_modules/lower-case": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", + "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", + "license": "MIT", + "dependencies": { + "tslib": "^2.0.3" + } + }, + "node_modules/lowercase-keys": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", + "integrity": "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "license": "ISC", + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/markdown-extensions": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz", + "integrity": "sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==", + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/markdown-table": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.4.tgz", + "integrity": "sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/mdast-util-directive": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-directive/-/mdast-util-directive-3.1.0.tgz", + "integrity": "sha512-I3fNFt+DHmpWCYAT7quoM6lHf9wuqtI+oCOfvILnoicNIqjh5E3dEJWiXuYME2gNe8vl1iMQwyUHa7bgFmak6Q==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-find-and-replace": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.2.tgz", + "integrity": "sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "escape-string-regexp": "^5.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-find-and-replace/node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mdast-util-from-markdown": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.3.tgz", + "integrity": "sha512-W4mAWTvSlKvf8L6J+VN9yLSqQ9AOAAvHuoDAmPkz4dHf553m5gVj2ejadHJhoJmcmxEnOv6Pa8XJhpxE93kb8Q==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark": "^4.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-from-markdown/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/mdast-util-frontmatter": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-frontmatter/-/mdast-util-frontmatter-2.0.1.tgz", + "integrity": "sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "escape-string-regexp": "^5.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "micromark-extension-frontmatter": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-frontmatter/node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mdast-util-gfm": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm/-/mdast-util-gfm-3.1.0.tgz", + "integrity": "sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ==", + "license": "MIT", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-gfm-autolink-literal": "^2.0.0", + "mdast-util-gfm-footnote": "^2.0.0", + "mdast-util-gfm-strikethrough": "^2.0.0", + "mdast-util-gfm-table": "^2.0.0", + "mdast-util-gfm-task-list-item": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-autolink-literal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-autolink-literal/-/mdast-util-gfm-autolink-literal-2.0.1.tgz", + "integrity": "sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-find-and-replace": "^3.0.0", + "micromark-util-character": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-autolink-literal/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/mdast-util-gfm-autolink-literal/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/mdast-util-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-strikethrough": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-strikethrough/-/mdast-util-gfm-strikethrough-2.0.0.tgz", + "integrity": "sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-table": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-table/-/mdast-util-gfm-table-2.0.0.tgz", + "integrity": "sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "markdown-table": "^3.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-task-list-item": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-task-list-item/-/mdast-util-gfm-task-list-item-2.0.0.tgz", + "integrity": "sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz", + "integrity": "sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w==", + "license": "MIT", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-expression": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.1.tgz", + "integrity": "sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-jsx": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.2.0.tgz", + "integrity": "sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-stringify-position": "^4.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdxjs-esm": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz", + "integrity": "sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-phrasing": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz", + "integrity": "sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-hast": { + "version": "13.2.1", + "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.1.tgz", + "integrity": "sha512-cctsq2wp5vTsLIcaymblUriiTcZd0CwWtCbLvrOzYCDZoWyMNV8sZ7krj09FSnsiJi3WVsHLM4k6Dq/yaPyCXA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@ungap/structured-clone": "^1.0.0", + "devlop": "^1.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "trim-lines": "^3.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-markdown": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.2.tgz", + "integrity": "sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "longest-streak": "^3.0.0", + "mdast-util-phrasing": "^4.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz", + "integrity": "sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdn-data": { + "version": "2.0.30", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.30.tgz", + "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==", + "license": "CC0-1.0" + }, + "node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/memfs": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/memfs/-/memfs-4.57.1.tgz", + "integrity": "sha512-WvzrWPwMQT+PtbX2Et64R4qXKK0fj/8pO85MrUCzymX3twwCiJCdvntW3HdhG1teLJcHDDLIKx5+c3HckWYZtQ==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-core": "4.57.1", + "@jsonjoy.com/fs-fsa": "4.57.1", + "@jsonjoy.com/fs-node": "4.57.1", + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-to-fsa": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "@jsonjoy.com/fs-print": "4.57.1", + "@jsonjoy.com/fs-snapshot": "4.57.1", + "@jsonjoy.com/json-pack": "^1.11.0", + "@jsonjoy.com/util": "^1.9.0", + "glob-to-regex.js": "^1.0.1", + "thingies": "^2.5.0", + "tree-dump": "^1.0.3", + "tslib": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/merge-descriptors": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz", + "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "license": "MIT" + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/methods": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", + "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/micromark": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", + "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/debug": "^4.0.0", + "debug": "^4.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz", + "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-destination": "^2.0.0", + "micromark-factory-label": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-title": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-html-tag-name": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-directive": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-3.0.2.tgz", + "integrity": "sha512-wjcXHgk+PPdmvR58Le9d7zQYWy+vKEU9Se44p2CrCDPiLr2FMyiT4Fyb5UFKFC66wGB3kPlgD7q3TnoqPS7SZA==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "parse-entities": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-frontmatter": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-frontmatter/-/micromark-extension-frontmatter-2.0.0.tgz", + "integrity": "sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg==", + "license": "MIT", + "dependencies": { + "fault": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-frontmatter/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-frontmatter/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz", + "integrity": "sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w==", + "license": "MIT", + "dependencies": { + "micromark-extension-gfm-autolink-literal": "^2.0.0", + "micromark-extension-gfm-footnote": "^2.0.0", + "micromark-extension-gfm-strikethrough": "^2.0.0", + "micromark-extension-gfm-table": "^2.0.0", + "micromark-extension-gfm-tagfilter": "^2.0.0", + "micromark-extension-gfm-task-list-item": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz", + "integrity": "sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==", + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm-strikethrough": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-strikethrough/-/micromark-extension-gfm-strikethrough-2.1.0.tgz", + "integrity": "sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-strikethrough/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm-table": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz", + "integrity": "sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm-tagfilter": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-tagfilter/-/micromark-extension-gfm-tagfilter-2.0.0.tgz", + "integrity": "sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg==", + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-task-list-item": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-task-list-item/-/micromark-extension-gfm-task-list-item-2.1.0.tgz", + "integrity": "sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-mdx-expression": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.1.tgz", + "integrity": "sha512-dD/ADLJ1AeMvSAKBwO22zG22N4ybhe7kFIZ3LsDI0GlsNr2A3KYxb0LdC1u5rj4Nw+CHKY0RVdnHX8vj8ejm4Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-mdx-jsx": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-jsx/-/micromark-extension-mdx-jsx-3.0.2.tgz", + "integrity": "sha512-e5+q1DjMh62LZAJOnDraSSbDMvGJ8x3cbjygy2qFEi7HCeUT4BDKCvMozPozcD6WmOt6sVvYDNBKhFSz3kjOVQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-mdx-md": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-md/-/micromark-extension-mdx-md-2.0.0.tgz", + "integrity": "sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ==", + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs/-/micromark-extension-mdxjs-3.0.0.tgz", + "integrity": "sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ==", + "license": "MIT", + "dependencies": { + "acorn": "^8.0.0", + "acorn-jsx": "^5.0.0", + "micromark-extension-mdx-expression": "^3.0.0", + "micromark-extension-mdx-jsx": "^3.0.0", + "micromark-extension-mdx-md": "^2.0.0", + "micromark-extension-mdxjs-esm": "^3.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs-esm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs-esm/-/micromark-extension-mdxjs-esm-3.0.0.tgz", + "integrity": "sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs-esm/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdxjs-esm/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-destination": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz", + "integrity": "sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-destination/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-destination/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-label": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz", + "integrity": "sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-mdx-expression": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-factory-mdx-expression/-/micromark-factory-mdx-expression-2.0.3.tgz", + "integrity": "sha512-kQnEtA3vzucU2BkrIa8/VaSAsP+EJ3CKOvhMuJgOEGg9KDC6OAY6nSnNDVRiVNRqj7Y4SlSzcStaH/5jge8JdQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-space": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-1.1.0.tgz", + "integrity": "sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^1.0.0", + "micromark-util-types": "^1.0.0" + } + }, + "node_modules/micromark-factory-space/node_modules/micromark-util-types": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", + "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-title": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz", + "integrity": "sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-whitespace": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz", + "integrity": "sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-character": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-1.2.0.tgz", + "integrity": "sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^1.0.0", + "micromark-util-types": "^1.0.0" + } + }, + "node_modules/micromark-util-character/node_modules/micromark-util-types": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", + "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-chunked": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz", + "integrity": "sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-chunked/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-classify-character": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz", + "integrity": "sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-combine-extensions": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz", + "integrity": "sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-chunked": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz", + "integrity": "sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-decode-string": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-2.0.1.tgz", + "integrity": "sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-encode": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", + "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-events-to-acorn": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-util-events-to-acorn/-/micromark-util-events-to-acorn-2.0.3.tgz", + "integrity": "sha512-jmsiEIiZ1n7X1Rr5k8wVExBQCg5jy4UXVADItHmNk1zkwEVhBuIUKRu3fqv+hs4nxLISi2DQGlqIOGiFxgbfHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-util-events-to-acorn/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-html-tag-name": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz", + "integrity": "sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-normalize-identifier": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz", + "integrity": "sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-normalize-identifier/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-resolve-all": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz", + "integrity": "sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", + "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-subtokenize": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz", + "integrity": "sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-subtokenize/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-symbol": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-1.1.0.tgz", + "integrity": "sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-types": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", + "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "license": "MIT", + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/mime-db": { + "version": "1.33.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz", + "integrity": "sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.18", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz", + "integrity": "sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ==", + "license": "MIT", + "dependencies": { + "mime-db": "~1.33.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/mimic-response": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-4.0.0.tgz", + "integrity": "sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mini-css-extract-plugin": { + "version": "2.10.2", + "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-2.10.2.tgz", + "integrity": "sha512-AOSS0IdEB95ayVkxn5oGzNQwqAi2J0Jb/kKm43t7H73s8+f5873g0yuj0PNvK4dO75mu5DHg4nlgp4k6Kga8eg==", + "license": "MIT", + "dependencies": { + "schema-utils": "^4.0.0", + "tapable": "^2.2.1" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + } + }, + "node_modules/minimalistic-assert": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz", + "integrity": "sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==", + "license": "ISC" + }, + "node_modules/minimatch": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/mrmime": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.1.tgz", + "integrity": "sha512-Y3wQdFg2Va6etvQ5I82yUhGdsKrcYox6p7FfL1LbK2J4V01F9TGlepTIhnK24t7koZibmg82KGglhA1XK5IsLQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/multicast-dns": { + "version": "7.2.5", + "resolved": "https://registry.npmjs.org/multicast-dns/-/multicast-dns-7.2.5.tgz", + "integrity": "sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg==", + "license": "MIT", + "dependencies": { + "dns-packet": "^5.2.2", + "thunky": "^1.0.2" + }, + "bin": { + "multicast-dns": "cli.js" + } + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/negotiator": { + "version": "0.6.4", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.4.tgz", + "integrity": "sha512-myRT3DiWPHqho5PrJaIRyaMv2kgYf0mUVgBNOYMuCH5Ki1yEiQaf/ZJuQ62nvpc44wL5WDbTX7yGJi1Neevw8w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "license": "MIT" + }, + "node_modules/no-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", + "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", + "license": "MIT", + "dependencies": { + "lower-case": "^2.0.2", + "tslib": "^2.0.3" + } + }, + "node_modules/node-emoji": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/node-emoji/-/node-emoji-2.2.0.tgz", + "integrity": "sha512-Z3lTE9pLaJF47NyMhd4ww1yFTAP8YhYI8SleJiHzM46Fgpm5cnNzSl9XfzFNqbaz+VlJrIj3fXQ4DeN1Rjm6cw==", + "license": "MIT", + "dependencies": { + "@sindresorhus/is": "^4.6.0", + "char-regex": "^1.0.2", + "emojilib": "^2.4.0", + "skin-tone": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/node-releases": { + "version": "2.0.36", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.36.tgz", + "integrity": "sha512-TdC8FSgHz8Mwtw9g5L4gR/Sh9XhSP/0DEkQxfEFXOpiul5IiHgHan2VhYYb6agDSfp4KuvltmGApc8HMgUrIkA==", + "license": "MIT" + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/normalize-url": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-8.1.1.tgz", + "integrity": "sha512-JYc0DPlpGWB40kH5g07gGTrYuMqV653k3uBKY6uITPWds3M0ov3GaWGp9lbE3Bzngx8+XkfzgvASb9vk9JDFXQ==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "license": "MIT", + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/nprogress": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/nprogress/-/nprogress-0.2.0.tgz", + "integrity": "sha512-I19aIingLgR1fmhftnbWWO3dXc0hSxqHQHQb3H8m+K3TnEn/iSeTZZOyvKXWqQESMwuUVnatlCnZdLBZZt2VSA==", + "license": "MIT" + }, + "node_modules/nth-check": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", + "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0" + }, + "funding": { + "url": "https://github.com/fb55/nth-check?sponsor=1" + } + }, + "node_modules/null-loader": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/null-loader/-/null-loader-4.0.1.tgz", + "integrity": "sha512-pxqVbi4U6N26lq+LmgIbB5XATP0VdZKOG25DhHi8btMmJJefGArFyDg1yc4U3hWCJbMqSrw0qyrz1UQX+qYXqg==", + "license": "MIT", + "dependencies": { + "loader-utils": "^2.0.0", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/null-loader/node_modules/ajv": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", + "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/null-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "license": "MIT", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/null-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "license": "MIT" + }, + "node_modules/null-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", + "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0", + "has-symbols": "^1.1.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/obuf": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/obuf/-/obuf-1.1.2.tgz", + "integrity": "sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg==", + "license": "MIT" + }, + "node_modules/on-finished": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", + "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", + "license": "MIT", + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/on-headers": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/on-headers/-/on-headers-1.1.0.tgz", + "integrity": "sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "license": "MIT", + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/open": { + "version": "8.4.2", + "resolved": "https://registry.npmjs.org/open/-/open-8.4.2.tgz", + "integrity": "sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==", + "license": "MIT", + "dependencies": { + "define-lazy-prop": "^2.0.0", + "is-docker": "^2.1.1", + "is-wsl": "^2.2.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/opener": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", + "integrity": "sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==", + "license": "(WTFPL OR MIT)", + "bin": { + "opener": "bin/opener-bin.js" + } + }, + "node_modules/p-cancelable": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-3.0.0.tgz", + "integrity": "sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw==", + "license": "MIT", + "engines": { + "node": ">=12.20" + } + }, + "node_modules/p-finally": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", + "integrity": "sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/p-limit": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-4.0.0.tgz", + "integrity": "sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ==", + "license": "MIT", + "dependencies": { + "yocto-queue": "^1.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-6.0.0.tgz", + "integrity": "sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw==", + "license": "MIT", + "dependencies": { + "p-limit": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-map": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", + "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", + "license": "MIT", + "dependencies": { + "aggregate-error": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-queue": { + "version": "6.6.2", + "resolved": "https://registry.npmjs.org/p-queue/-/p-queue-6.6.2.tgz", + "integrity": "sha512-RwFpb72c/BhQLEXIZ5K2e+AhgNVmIejGlTgiB9MzZ0e93GRvqZ7uSi0dvRF7/XIXDeNkra2fNHBxTyPDGySpjQ==", + "license": "MIT", + "dependencies": { + "eventemitter3": "^4.0.4", + "p-timeout": "^3.2.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-retry": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/p-retry/-/p-retry-6.2.1.tgz", + "integrity": "sha512-hEt02O4hUct5wtwg4H4KcWgDdm+l1bOaEy/hWzd8xtXB9BqxTWBBhb+2ImAtH4Cv4rPjV76xN3Zumqk3k3AhhQ==", + "license": "MIT", + "dependencies": { + "@types/retry": "0.12.2", + "is-network-error": "^1.0.0", + "retry": "^0.13.1" + }, + "engines": { + "node": ">=16.17" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-timeout": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/p-timeout/-/p-timeout-3.2.0.tgz", + "integrity": "sha512-rhIwUycgwwKcP9yTOOFK/AKsAopjjCakVqLHePO3CC6Mir1Z99xT+R63jZxAT5lFZLa2inS5h+ZS2GvR99/FBg==", + "license": "MIT", + "dependencies": { + "p-finally": "^1.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/package-json": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.1.tgz", + "integrity": "sha512-cbH9IAIJHNj9uXi196JVsRlt7cHKak6u/e6AkL/bkRelZ7rlL3X1YKxsZwa36xipOEKAsdtmaG6aAJoM1fx2zA==", + "license": "MIT", + "dependencies": { + "got": "^12.1.0", + "registry-auth-token": "^5.0.1", + "registry-url": "^6.0.0", + "semver": "^7.3.7" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/param-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", + "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", + "license": "MIT", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "license": "MIT", + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-entities": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.2.tgz", + "integrity": "sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^2.0.0", + "character-entities-legacy": "^3.0.0", + "character-reference-invalid": "^2.0.0", + "decode-named-character-reference": "^1.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0", + "is-hexadecimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/parse-entities/node_modules/@types/unist": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.11.tgz", + "integrity": "sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==", + "license": "MIT" + }, + "node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parse-numeric-range": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz", + "integrity": "sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ==", + "license": "ISC" + }, + "node_modules/parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "license": "MIT", + "dependencies": { + "entities": "^6.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-htmlparser2-tree-adapter": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz", + "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==", + "license": "MIT", + "dependencies": { + "domhandler": "^5.0.3", + "parse5": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5/node_modules/entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/parseurl": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", + "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/pascal-case": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", + "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/path-exists": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-5.0.0.tgz", + "integrity": "sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + } + }, + "node_modules/path-is-inside": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", + "integrity": "sha512-DUWJr3+ULp4zXmol/SZkFf3JGsS9/SIv+Y3Rt93/UjPpDpklB5f1er4O3POIbUuUJ3FXgqte2Q7SrU6zAqwk8w==", + "license": "(WTFPL OR MIT)" + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "license": "MIT" + }, + "node_modules/path-to-regexp": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", + "integrity": "sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g==", + "license": "MIT", + "dependencies": { + "isarray": "0.0.1" + } + }, + "node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pkg-dir": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-7.0.0.tgz", + "integrity": "sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA==", + "license": "MIT", + "dependencies": { + "find-up": "^6.3.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkijs": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/pkijs/-/pkijs-3.4.0.tgz", + "integrity": "sha512-emEcLuomt2j03vxD54giVB4SxTjnsqkU692xZOZXHDVoYyypEm+b3jpiTcc+Cf+myooc+/Ly0z01jqeNHVgJGw==", + "license": "BSD-3-Clause", + "dependencies": { + "@noble/hashes": "1.4.0", + "asn1js": "^3.0.6", + "bytestreamjs": "^2.0.1", + "pvtsutils": "^1.3.6", + "pvutils": "^1.1.3", + "tslib": "^2.8.1" + }, + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/postcss": { + "version": "8.5.8", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz", + "integrity": "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/postcss-attribute-case-insensitive": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/postcss-attribute-case-insensitive/-/postcss-attribute-case-insensitive-7.0.1.tgz", + "integrity": "sha512-Uai+SupNSqzlschRyNx3kbCTWgY/2hcwtHEI/ej2LJWc9JJ77qKgGptd8DHwY1mXtZ7Aoh4z4yxfwMBue9eNgw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-attribute-case-insensitive/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-calc": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/postcss-calc/-/postcss-calc-9.0.1.tgz", + "integrity": "sha512-TipgjGyzP5QzEhsOZUaIkeO5mKeMFpebWzRogWG/ysonUlnHcq5aJe0jOjpfzUU8PeSaBQnrE8ehR0QA5vs8PQ==", + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.0.11", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.2.2" + } + }, + "node_modules/postcss-clamp": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/postcss-clamp/-/postcss-clamp-4.1.0.tgz", + "integrity": "sha512-ry4b1Llo/9zz+PKC+030KUnPITTJAHeOwjfAyyB60eT0AorGLdzp52s31OsPRHRf8NchkgFoG2y6fCfn1IV1Ow==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=7.6.0" + }, + "peerDependencies": { + "postcss": "^8.4.6" + } + }, + "node_modules/postcss-color-functional-notation": { + "version": "7.0.12", + "resolved": "https://registry.npmjs.org/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.12.tgz", + "integrity": "sha512-TLCW9fN5kvO/u38/uesdpbx3e8AkTYhMvDZYa9JpmImWuTE99bDQ7GU7hdOADIZsiI9/zuxfAJxny/khknp1Zw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-color-hex-alpha": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/postcss-color-hex-alpha/-/postcss-color-hex-alpha-10.0.0.tgz", + "integrity": "sha512-1kervM2cnlgPs2a8Vt/Qbe5cQ++N7rkYo/2rz2BkqJZIHQwaVuJgQH38REHrAi4uM0b1fqxMkWYmese94iMp3w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-color-rebeccapurple": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/postcss-color-rebeccapurple/-/postcss-color-rebeccapurple-10.0.0.tgz", + "integrity": "sha512-JFta737jSP+hdAIEhk1Vs0q0YF5P8fFcj+09pweS8ktuGuZ8pPlykHsk6mPxZ8awDl4TrcxUqJo9l1IhVr/OjQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-colormin": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-colormin/-/postcss-colormin-6.1.0.tgz", + "integrity": "sha512-x9yX7DOxeMAR+BgGVnNSAxmAj98NX/YxEMNFP+SDCEeNLb2r3i6Hh1ksMsnW8Ub5SLCpbescQqn9YEbE9554Sw==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0", + "colord": "^2.9.3", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-convert-values": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-convert-values/-/postcss-convert-values-6.1.0.tgz", + "integrity": "sha512-zx8IwP/ts9WvUM6NkVSkiU902QZL1bwPhaVaLynPtCsOTqp+ZKbNi+s6XJg3rfqpKGA/oc7Oxk5t8pOQJcwl/w==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-custom-media": { + "version": "11.0.6", + "resolved": "https://registry.npmjs.org/postcss-custom-media/-/postcss-custom-media-11.0.6.tgz", + "integrity": "sha512-C4lD4b7mUIw+RZhtY7qUbf4eADmb7Ey8BFA2px9jUbwg7pjTZDl4KY4bvlUV+/vXQvzQRfiGEVJyAbtOsCMInw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/cascade-layer-name-parser": "^2.0.5", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/media-query-list-parser": "^4.0.3" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-custom-properties": { + "version": "14.0.6", + "resolved": "https://registry.npmjs.org/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz", + "integrity": "sha512-fTYSp3xuk4BUeVhxCSJdIPhDLpJfNakZKoiTDx7yRGCdlZrSJR7mWKVOBS4sBF+5poPQFMj2YdXx1VHItBGihQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/cascade-layer-name-parser": "^2.0.5", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-custom-selectors": { + "version": "8.0.5", + "resolved": "https://registry.npmjs.org/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz", + "integrity": "sha512-9PGmckHQswiB2usSO6XMSswO2yFWVoCAuih1yl9FVcwkscLjRKjwsjM3t+NIWpSU2Jx3eOiK2+t4vVTQaoCHHg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/cascade-layer-name-parser": "^2.0.5", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-custom-selectors/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-dir-pseudo-class": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/postcss-dir-pseudo-class/-/postcss-dir-pseudo-class-9.0.1.tgz", + "integrity": "sha512-tRBEK0MHYvcMUrAuYMEOa0zg9APqirBcgzi6P21OhxtJyJADo/SWBwY1CAwEohQ/6HDaa9jCjLRG7K3PVQYHEA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-dir-pseudo-class/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-discard-comments": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-discard-comments/-/postcss-discard-comments-6.0.2.tgz", + "integrity": "sha512-65w/uIqhSBBfQmYnG92FO1mWZjJ4GL5b8atm5Yw2UgrwD7HiNiSSNwJor1eCFGzUgYnN/iIknhNRVqjrrpuglw==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-duplicates": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-discard-duplicates/-/postcss-discard-duplicates-6.0.3.tgz", + "integrity": "sha512-+JA0DCvc5XvFAxwx6f/e68gQu/7Z9ud584VLmcgto28eB8FqSFZwtrLwB5Kcp70eIoWP/HXqz4wpo8rD8gpsTw==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-empty": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-discard-empty/-/postcss-discard-empty-6.0.3.tgz", + "integrity": "sha512-znyno9cHKQsK6PtxL5D19Fj9uwSzC2mB74cpT66fhgOadEUPyXFkbgwm5tvc3bt3NAy8ltE5MrghxovZRVnOjQ==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-overridden": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-discard-overridden/-/postcss-discard-overridden-6.0.2.tgz", + "integrity": "sha512-j87xzI4LUggC5zND7KdjsI25APtyMuynXZSujByMaav2roV6OZX+8AaCUcZSWqckZpjAjRyFDdpqybgjFO0HJQ==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-unused": { + "version": "6.0.5", + "resolved": "https://registry.npmjs.org/postcss-discard-unused/-/postcss-discard-unused-6.0.5.tgz", + "integrity": "sha512-wHalBlRHkaNnNwfC8z+ppX57VhvS+HWgjW508esjdaEYr3Mx7Gnn2xA4R/CKf5+Z9S5qsqC+Uzh4ueENWwCVUA==", + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-double-position-gradients": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.4.tgz", + "integrity": "sha512-m6IKmxo7FxSP5nF2l63QbCC3r+bWpFUWmZXZf096WxG0m7Vl1Q1+ruFOhpdDRmKrRS+S3Jtk+TVk/7z0+BVK6g==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-focus-visible": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/postcss-focus-visible/-/postcss-focus-visible-10.0.1.tgz", + "integrity": "sha512-U58wyjS/I1GZgjRok33aE8juW9qQgQUNwTSdxQGuShHzwuYdcklnvK/+qOWX1Q9kr7ysbraQ6ht6r+udansalA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-focus-visible/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-focus-within": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/postcss-focus-within/-/postcss-focus-within-9.0.1.tgz", + "integrity": "sha512-fzNUyS1yOYa7mOjpci/bR+u+ESvdar6hk8XNK/TRR0fiGTp2QT5N+ducP0n3rfH/m9I7H/EQU6lsa2BrgxkEjw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-focus-within/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-font-variant": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/postcss-font-variant/-/postcss-font-variant-5.0.0.tgz", + "integrity": "sha512-1fmkBaCALD72CK2a9i468mA/+tr9/1cBxRRMXOUaZqO43oWPR5imcyPjXwuv7PXbCid4ndlP5zWhidQVVa3hmA==", + "license": "MIT", + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-gap-properties": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/postcss-gap-properties/-/postcss-gap-properties-6.0.0.tgz", + "integrity": "sha512-Om0WPjEwiM9Ru+VhfEDPZJAKWUd0mV1HmNXqp2C29z80aQ2uP9UVhLc7e3aYMIor/S5cVhoPgYQ7RtfeZpYTRw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-image-set-function": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/postcss-image-set-function/-/postcss-image-set-function-7.0.0.tgz", + "integrity": "sha512-QL7W7QNlZuzOwBTeXEmbVckNt1FSmhQtbMRvGGqqU4Nf4xk6KUEQhAoWuMzwbSv5jxiRiSZ5Tv7eiDB9U87znA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-lab-function": { + "version": "7.0.12", + "resolved": "https://registry.npmjs.org/postcss-lab-function/-/postcss-lab-function-7.0.12.tgz", + "integrity": "sha512-tUcyRk1ZTPec3OuKFsqtRzW2Go5lehW29XA21lZ65XmzQkz43VY2tyWEC202F7W3mILOjw0voOiuxRGTsN+J9w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-loader": { + "version": "7.3.4", + "resolved": "https://registry.npmjs.org/postcss-loader/-/postcss-loader-7.3.4.tgz", + "integrity": "sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A==", + "license": "MIT", + "dependencies": { + "cosmiconfig": "^8.3.5", + "jiti": "^1.20.0", + "semver": "^7.5.4" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "postcss": "^7.0.0 || ^8.0.1", + "webpack": "^5.0.0" + } + }, + "node_modules/postcss-logical": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/postcss-logical/-/postcss-logical-8.1.0.tgz", + "integrity": "sha512-pL1hXFQ2fEXNKiNiAgtfA005T9FBxky5zkX6s4GZM2D8RkVgRqz3f4g1JUoq925zXv495qk8UNldDwh8uGEDoA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-merge-idents": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-merge-idents/-/postcss-merge-idents-6.0.3.tgz", + "integrity": "sha512-1oIoAsODUs6IHQZkLQGO15uGEbK3EAl5wi9SS8hs45VgsxQfMnxvt+L+zIr7ifZFIH14cfAeVe2uCTa+SPRa3g==", + "license": "MIT", + "dependencies": { + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-merge-longhand": { + "version": "6.0.5", + "resolved": "https://registry.npmjs.org/postcss-merge-longhand/-/postcss-merge-longhand-6.0.5.tgz", + "integrity": "sha512-5LOiordeTfi64QhICp07nzzuTDjNSO8g5Ksdibt44d+uvIIAE1oZdRn8y/W5ZtYgRH/lnLDlvi9F8btZcVzu3w==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0", + "stylehacks": "^6.1.1" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-merge-rules": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/postcss-merge-rules/-/postcss-merge-rules-6.1.1.tgz", + "integrity": "sha512-KOdWF0gju31AQPZiD+2Ar9Qjowz1LTChSjFFbS+e2sFgc4uHOp3ZvVX4sNeTlk0w2O31ecFGgrFzhO0RSWbWwQ==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0", + "cssnano-utils": "^4.0.2", + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-font-values": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-minify-font-values/-/postcss-minify-font-values-6.1.0.tgz", + "integrity": "sha512-gklfI/n+9rTh8nYaSJXlCo3nOKqMNkxuGpTn/Qm0gstL3ywTr9/WRKznE+oy6fvfolH6dF+QM4nCo8yPLdvGJg==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-gradients": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-minify-gradients/-/postcss-minify-gradients-6.0.3.tgz", + "integrity": "sha512-4KXAHrYlzF0Rr7uc4VrfwDJ2ajrtNEpNEuLxFgwkhFZ56/7gaE4Nr49nLsQDZyUe+ds+kEhf+YAUolJiYXF8+Q==", + "license": "MIT", + "dependencies": { + "colord": "^2.9.3", + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-params": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-minify-params/-/postcss-minify-params-6.1.0.tgz", + "integrity": "sha512-bmSKnDtyyE8ujHQK0RQJDIKhQ20Jq1LYiez54WiaOoBtcSuflfK3Nm596LvbtlFcpipMjgClQGyGr7GAs+H1uA==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-selectors": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/postcss-minify-selectors/-/postcss-minify-selectors-6.0.4.tgz", + "integrity": "sha512-L8dZSwNLgK7pjTto9PzWRoMbnLq5vsZSTu8+j1P/2GB8qdtGQfn+K1uSvFgYvgh83cbyxT5m43ZZhUMTJDSClQ==", + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-modules-extract-imports": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/postcss-modules-extract-imports/-/postcss-modules-extract-imports-3.1.0.tgz", + "integrity": "sha512-k3kNe0aNFQDAZGbin48pL2VNidTF0w4/eASDsxlyspobzU3wZQLOGj7L9gfRe0Jo9/4uud09DsjFNH7winGv8Q==", + "license": "ISC", + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-local-by-default": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/postcss-modules-local-by-default/-/postcss-modules-local-by-default-4.2.0.tgz", + "integrity": "sha512-5kcJm/zk+GJDSfw+V/42fJ5fhjL5YbFDl8nVdXkJPLLW+Vf9mTD5Xe0wqIaDnLuL2U6cDNpTr+UQ+v2HWIBhzw==", + "license": "MIT", + "dependencies": { + "icss-utils": "^5.0.0", + "postcss-selector-parser": "^7.0.0", + "postcss-value-parser": "^4.1.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-local-by-default/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-modules-scope": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/postcss-modules-scope/-/postcss-modules-scope-3.2.1.tgz", + "integrity": "sha512-m9jZstCVaqGjTAuny8MdgE88scJnCiQSlSrOWcTQgM2t32UBe+MUmFSO5t7VMSfAf/FJKImAxBav8ooCHJXCJA==", + "license": "ISC", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-scope/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-modules-values": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/postcss-modules-values/-/postcss-modules-values-4.0.0.tgz", + "integrity": "sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ==", + "license": "ISC", + "dependencies": { + "icss-utils": "^5.0.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-nesting": { + "version": "13.0.2", + "resolved": "https://registry.npmjs.org/postcss-nesting/-/postcss-nesting-13.0.2.tgz", + "integrity": "sha512-1YCI290TX+VP0U/K/aFxzHzQWHWURL+CtHMSbex1lCdpXD1SoR2sYuxDu5aNI9lPoXpKTCggFZiDJbwylU0LEQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/selector-resolve-nested": "^3.1.0", + "@csstools/selector-specificity": "^5.0.0", + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-nesting/node_modules/@csstools/selector-resolve-nested": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.1.0.tgz", + "integrity": "sha512-mf1LEW0tJLKfWyvn5KdDrhpxHyuxpbNwTIwOYLIvsTffeyOf85j5oIzfG0yosxDgx/sswlqBnESYUcQH0vgZ0g==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/postcss-nesting/node_modules/@csstools/selector-specificity": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", + "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/postcss-nesting/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-normalize-charset": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-charset/-/postcss-normalize-charset-6.0.2.tgz", + "integrity": "sha512-a8N9czmdnrjPHa3DeFlwqst5eaL5W8jYu3EBbTTkI5FHkfMhFZh1EGbku6jhHhIzTA6tquI2P42NtZ59M/H/kQ==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-display-values": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-display-values/-/postcss-normalize-display-values-6.0.2.tgz", + "integrity": "sha512-8H04Mxsb82ON/aAkPeq8kcBbAtI5Q2a64X/mnRRfPXBq7XeogoQvReqxEfc0B4WPq1KimjezNC8flUtC3Qz6jg==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-positions": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-positions/-/postcss-normalize-positions-6.0.2.tgz", + "integrity": "sha512-/JFzI441OAB9O7VnLA+RtSNZvQ0NCFZDOtp6QPFo1iIyawyXg0YI3CYM9HBy1WvwCRHnPep/BvI1+dGPKoXx/Q==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-repeat-style": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-6.0.2.tgz", + "integrity": "sha512-YdCgsfHkJ2jEXwR4RR3Tm/iOxSfdRt7jplS6XRh9Js9PyCR/aka/FCb6TuHT2U8gQubbm/mPmF6L7FY9d79VwQ==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-string": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-string/-/postcss-normalize-string-6.0.2.tgz", + "integrity": "sha512-vQZIivlxlfqqMp4L9PZsFE4YUkWniziKjQWUtsxUiVsSSPelQydwS8Wwcuw0+83ZjPWNTl02oxlIvXsmmG+CiQ==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-timing-functions": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-6.0.2.tgz", + "integrity": "sha512-a+YrtMox4TBtId/AEwbA03VcJgtyW4dGBizPl7e88cTFULYsprgHWTbfyjSLyHeBcK/Q9JhXkt2ZXiwaVHoMzA==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-unicode": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-normalize-unicode/-/postcss-normalize-unicode-6.1.0.tgz", + "integrity": "sha512-QVC5TQHsVj33otj8/JD869Ndr5Xcc/+fwRh4HAsFsAeygQQXm+0PySrKbr/8tkDKzW+EVT3QkqZMfFrGiossDg==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-url": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-url/-/postcss-normalize-url-6.0.2.tgz", + "integrity": "sha512-kVNcWhCeKAzZ8B4pv/DnrU1wNh458zBNp8dh4y5hhxih5RZQ12QWMuQrDgPRw3LRl8mN9vOVfHl7uhvHYMoXsQ==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-whitespace": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-whitespace/-/postcss-normalize-whitespace-6.0.2.tgz", + "integrity": "sha512-sXZ2Nj1icbJOKmdjXVT9pnyHQKiSAyuNQHSgRCUgThn2388Y9cGVDR+E9J9iAYbSbLHI+UUwLVl1Wzco/zgv0Q==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-opacity-percentage": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/postcss-opacity-percentage/-/postcss-opacity-percentage-3.0.0.tgz", + "integrity": "sha512-K6HGVzyxUxd/VgZdX04DCtdwWJ4NGLG212US4/LA1TLAbHgmAsTWVR86o+gGIbFtnTkfOpb9sCRBx8K7HO66qQ==", + "funding": [ + { + "type": "kofi", + "url": "https://ko-fi.com/mrcgrtz" + }, + { + "type": "liberapay", + "url": "https://liberapay.com/mrcgrtz" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-ordered-values": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-ordered-values/-/postcss-ordered-values-6.0.2.tgz", + "integrity": "sha512-VRZSOB+JU32RsEAQrO94QPkClGPKJEL/Z9PCBImXMhIeK5KAYo6slP/hBYlLgrCjFxyqvn5VC81tycFEDBLG1Q==", + "license": "MIT", + "dependencies": { + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-overflow-shorthand": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/postcss-overflow-shorthand/-/postcss-overflow-shorthand-6.0.0.tgz", + "integrity": "sha512-BdDl/AbVkDjoTofzDQnwDdm/Ym6oS9KgmO7Gr+LHYjNWJ6ExORe4+3pcLQsLA9gIROMkiGVjjwZNoL/mpXHd5Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-page-break": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/postcss-page-break/-/postcss-page-break-3.0.4.tgz", + "integrity": "sha512-1JGu8oCjVXLa9q9rFTo4MbeeA5FMe00/9C7lN4va606Rdb+HkxXtXsmEDrIraQ11fGz/WvKWa8gMuCKkrXpTsQ==", + "license": "MIT", + "peerDependencies": { + "postcss": "^8" + } + }, + "node_modules/postcss-place": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/postcss-place/-/postcss-place-10.0.0.tgz", + "integrity": "sha512-5EBrMzat2pPAxQNWYavwAfoKfYcTADJ8AXGVPcUZ2UkNloUTWzJQExgrzrDkh3EKzmAx1evfTAzF9I8NGcc+qw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-preset-env": { + "version": "10.6.1", + "resolved": "https://registry.npmjs.org/postcss-preset-env/-/postcss-preset-env-10.6.1.tgz", + "integrity": "sha512-yrk74d9EvY+W7+lO9Aj1QmjWY9q5NsKjK2V9drkOPZB/X6KZ0B3igKsHUYakb7oYVhnioWypQX3xGuePf89f3g==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/postcss-alpha-function": "^1.0.1", + "@csstools/postcss-cascade-layers": "^5.0.2", + "@csstools/postcss-color-function": "^4.0.12", + "@csstools/postcss-color-function-display-p3-linear": "^1.0.1", + "@csstools/postcss-color-mix-function": "^3.0.12", + "@csstools/postcss-color-mix-variadic-function-arguments": "^1.0.2", + "@csstools/postcss-content-alt-text": "^2.0.8", + "@csstools/postcss-contrast-color-function": "^2.0.12", + "@csstools/postcss-exponential-functions": "^2.0.9", + "@csstools/postcss-font-format-keywords": "^4.0.0", + "@csstools/postcss-gamut-mapping": "^2.0.11", + "@csstools/postcss-gradients-interpolation-method": "^5.0.12", + "@csstools/postcss-hwb-function": "^4.0.12", + "@csstools/postcss-ic-unit": "^4.0.4", + "@csstools/postcss-initial": "^2.0.1", + "@csstools/postcss-is-pseudo-class": "^5.0.3", + "@csstools/postcss-light-dark-function": "^2.0.11", + "@csstools/postcss-logical-float-and-clear": "^3.0.0", + "@csstools/postcss-logical-overflow": "^2.0.0", + "@csstools/postcss-logical-overscroll-behavior": "^2.0.0", + "@csstools/postcss-logical-resize": "^3.0.0", + "@csstools/postcss-logical-viewport-units": "^3.0.4", + "@csstools/postcss-media-minmax": "^2.0.9", + "@csstools/postcss-media-queries-aspect-ratio-number-values": "^3.0.5", + "@csstools/postcss-nested-calc": "^4.0.0", + "@csstools/postcss-normalize-display-values": "^4.0.1", + "@csstools/postcss-oklab-function": "^4.0.12", + "@csstools/postcss-position-area-property": "^1.0.0", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/postcss-property-rule-prelude-list": "^1.0.0", + "@csstools/postcss-random-function": "^2.0.1", + "@csstools/postcss-relative-color-syntax": "^3.0.12", + "@csstools/postcss-scope-pseudo-class": "^4.0.1", + "@csstools/postcss-sign-functions": "^1.1.4", + "@csstools/postcss-stepped-value-functions": "^4.0.9", + "@csstools/postcss-syntax-descriptor-syntax-production": "^1.0.1", + "@csstools/postcss-system-ui-font-family": "^1.0.0", + "@csstools/postcss-text-decoration-shorthand": "^4.0.3", + "@csstools/postcss-trigonometric-functions": "^4.0.9", + "@csstools/postcss-unset-value": "^4.0.0", + "autoprefixer": "^10.4.23", + "browserslist": "^4.28.1", + "css-blank-pseudo": "^7.0.1", + "css-has-pseudo": "^7.0.3", + "css-prefers-color-scheme": "^10.0.0", + "cssdb": "^8.6.0", + "postcss-attribute-case-insensitive": "^7.0.1", + "postcss-clamp": "^4.1.0", + "postcss-color-functional-notation": "^7.0.12", + "postcss-color-hex-alpha": "^10.0.0", + "postcss-color-rebeccapurple": "^10.0.0", + "postcss-custom-media": "^11.0.6", + "postcss-custom-properties": "^14.0.6", + "postcss-custom-selectors": "^8.0.5", + "postcss-dir-pseudo-class": "^9.0.1", + "postcss-double-position-gradients": "^6.0.4", + "postcss-focus-visible": "^10.0.1", + "postcss-focus-within": "^9.0.1", + "postcss-font-variant": "^5.0.0", + "postcss-gap-properties": "^6.0.0", + "postcss-image-set-function": "^7.0.0", + "postcss-lab-function": "^7.0.12", + "postcss-logical": "^8.1.0", + "postcss-nesting": "^13.0.2", + "postcss-opacity-percentage": "^3.0.0", + "postcss-overflow-shorthand": "^6.0.0", + "postcss-page-break": "^3.0.4", + "postcss-place": "^10.0.0", + "postcss-pseudo-class-any-link": "^10.0.1", + "postcss-replace-overflow-wrap": "^4.0.0", + "postcss-selector-not": "^8.0.1" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-pseudo-class-any-link": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/postcss-pseudo-class-any-link/-/postcss-pseudo-class-any-link-10.0.1.tgz", + "integrity": "sha512-3el9rXlBOqTFaMFkWDOkHUTQekFIYnaQY55Rsp8As8QQkpiSgIYEcF/6Ond93oHiDsGb4kad8zjt+NPlOC1H0Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-pseudo-class-any-link/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-reduce-idents": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-reduce-idents/-/postcss-reduce-idents-6.0.3.tgz", + "integrity": "sha512-G3yCqZDpsNPoQgbDUy3T0E6hqOQ5xigUtBQyrmq3tn2GxlyiL0yyl7H+T8ulQR6kOcHJ9t7/9H4/R2tv8tJbMA==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-reduce-initial": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-reduce-initial/-/postcss-reduce-initial-6.1.0.tgz", + "integrity": "sha512-RarLgBK/CrL1qZags04oKbVbrrVK2wcxhvta3GCxrZO4zveibqbRPmm2VI8sSgCXwoUHEliRSbOfpR0b/VIoiw==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-reduce-transforms": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-reduce-transforms/-/postcss-reduce-transforms-6.0.2.tgz", + "integrity": "sha512-sB+Ya++3Xj1WaT9+5LOOdirAxP7dJZms3GRcYheSPi1PiTMigsxHAdkrbItHxwYHr4kt1zL7mmcHstgMYT+aiA==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-replace-overflow-wrap": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/postcss-replace-overflow-wrap/-/postcss-replace-overflow-wrap-4.0.0.tgz", + "integrity": "sha512-KmF7SBPphT4gPPcKZc7aDkweHiKEEO8cla/GjcBK+ckKxiZslIu3C4GCRW3DNfL0o7yW7kMQu9xlZ1kXRXLXtw==", + "license": "MIT", + "peerDependencies": { + "postcss": "^8.0.3" + } + }, + "node_modules/postcss-selector-not": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/postcss-selector-not/-/postcss-selector-not-8.0.1.tgz", + "integrity": "sha512-kmVy/5PYVb2UOhy0+LqUYAhKj7DUGDpSWa5LZqlkWJaaAV+dxxsOG3+St0yNLu6vsKD7Dmqx+nWQt0iil89+WA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-selector-not/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-selector-parser": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz", + "integrity": "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-sort-media-queries": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/postcss-sort-media-queries/-/postcss-sort-media-queries-5.2.0.tgz", + "integrity": "sha512-AZ5fDMLD8SldlAYlvi8NIqo0+Z8xnXU2ia0jxmuhxAU+Lqt9K+AlmLNJ/zWEnE9x+Zx3qL3+1K20ATgNOr3fAA==", + "license": "MIT", + "dependencies": { + "sort-css-media-queries": "2.2.0" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "postcss": "^8.4.23" + } + }, + "node_modules/postcss-svgo": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-svgo/-/postcss-svgo-6.0.3.tgz", + "integrity": "sha512-dlrahRmxP22bX6iKEjOM+c8/1p+81asjKT+V5lrgOH944ryx/OHpclnIbGsKVd3uWOXFLYJwCVf0eEkJGvO96g==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0", + "svgo": "^3.2.0" + }, + "engines": { + "node": "^14 || ^16 || >= 18" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-unique-selectors": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/postcss-unique-selectors/-/postcss-unique-selectors-6.0.4.tgz", + "integrity": "sha512-K38OCaIrO8+PzpArzkLKB42dSARtC2tmG6PvD4b1o1Q2E9Os8jzfWFfSy/rixsHwohtsDdFtAWGjFVFUdwYaMg==", + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-value-parser": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz", + "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==", + "license": "MIT" + }, + "node_modules/postcss-zindex": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-zindex/-/postcss-zindex-6.0.2.tgz", + "integrity": "sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/pretty-error": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz", + "integrity": "sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw==", + "license": "MIT", + "dependencies": { + "lodash": "^4.17.20", + "renderkid": "^3.0.0" + } + }, + "node_modules/pretty-time": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/pretty-time/-/pretty-time-1.1.0.tgz", + "integrity": "sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/prism-react-renderer": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/prism-react-renderer/-/prism-react-renderer-2.4.1.tgz", + "integrity": "sha512-ey8Ls/+Di31eqzUxC46h8MksNuGx/n0AAC8uKpwFau4RPDYLuE3EXTp8N8G2vX2N7UC/+IXeNUnlWBGGcAG+Ig==", + "license": "MIT", + "dependencies": { + "@types/prismjs": "^1.26.0", + "clsx": "^2.0.0" + }, + "peerDependencies": { + "react": ">=16.0.0" + } + }, + "node_modules/prismjs": { + "version": "1.30.0", + "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.30.0.tgz", + "integrity": "sha512-DEvV2ZF2r2/63V+tK8hQvrR2ZGn10srHbXviTlcv7Kpzw8jWiNTqbVgjO3IY8RxrrOUF8VPMQQFysYYYv0YZxw==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/process-nextick-args": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", + "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", + "license": "MIT" + }, + "node_modules/prompts": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", + "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "license": "MIT", + "dependencies": { + "kleur": "^3.0.3", + "sisteransi": "^1.0.5" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "license": "MIT", + "dependencies": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, + "node_modules/property-information": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-7.1.0.tgz", + "integrity": "sha512-TwEZ+X+yCJmYfL7TPUOcvBZ4QfoT5YenQiJuX//0th53DE6w0xxLEtfK3iyryQFddXuvkIk51EEgrJQ0WJkOmQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/proto-list": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", + "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", + "license": "ISC" + }, + "node_modules/proxy-addr": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", + "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", + "license": "MIT", + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/proxy-addr/node_modules/ipaddr.js": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", + "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/pupa": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.3.0.tgz", + "integrity": "sha512-LjgDO2zPtoXP2wJpDjZrGdojii1uqO0cnwKoIoUzkfS98HDmbeiGmYiXo3lXeFlq2xvne1QFQhwYXSUCLKtEuA==", + "license": "MIT", + "dependencies": { + "escape-goat": "^4.0.0" + }, + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pvtsutils": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/pvtsutils/-/pvtsutils-1.3.6.tgz", + "integrity": "sha512-PLgQXQ6H2FWCaeRak8vvk1GW462lMxB5s3Jm673N82zI4vqtVUPuZdffdZbPDFRoU8kAhItWFtPCWiPpp4/EDg==", + "license": "MIT", + "dependencies": { + "tslib": "^2.8.1" + } + }, + "node_modules/pvutils": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/pvutils/-/pvutils-1.1.5.tgz", + "integrity": "sha512-KTqnxsgGiQ6ZAzZCVlJH5eOjSnvlyEgx1m8bkRJfOhmGRqfo5KLvmAlACQkrjEtOQ4B7wF9TdSLIs9O90MX9xA==", + "license": "MIT", + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/qs": { + "version": "6.14.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.2.tgz", + "integrity": "sha512-V/yCWTTF7VJ9hIh18Ugr2zhJMP01MY7c5kh4J870L7imm6/DIzBsNLTXzMwUA3yZ5b/KBqLx8Kp3uRvd7xSe3Q==", + "license": "BSD-3-Clause", + "dependencies": { + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/quick-lru": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz", + "integrity": "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/randombytes": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", + "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", + "license": "MIT", + "dependencies": { + "safe-buffer": "^5.1.0" + } + }, + "node_modules/range-parser": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz", + "integrity": "sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/raw-body": { + "version": "2.5.3", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.3.tgz", + "integrity": "sha512-s4VSOf6yN0rvbRZGxs8Om5CWj6seneMwK3oDb4lWDH0UPhWcxwOWw5+qk24bxq87szX1ydrwylIOp2uG1ojUpA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "http-errors": "~2.0.1", + "iconv-lite": "~0.4.24", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/raw-body/node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/rc": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", + "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", + "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", + "dependencies": { + "deep-extend": "^0.6.0", + "ini": "~1.3.0", + "minimist": "^1.2.0", + "strip-json-comments": "~2.0.1" + }, + "bin": { + "rc": "cli.js" + } + }, + "node_modules/rc/node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "license": "ISC" + }, + "node_modules/rc/node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react": { + "version": "19.2.4", + "resolved": "https://registry.npmjs.org/react/-/react-19.2.4.tgz", + "integrity": "sha512-9nfp2hYpCwOjAN+8TZFGhtWEwgvWHXqESH8qT89AT/lWklpLON22Lc8pEtnpsZz7VmawabSU0gCjnj8aC0euHQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react-dom": { + "version": "19.2.4", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.4.tgz", + "integrity": "sha512-AXJdLo8kgMbimY95O2aKQqsz2iWi9jMgKJhRBAxECE4IFxfcazB2LmzloIoibJI3C12IlY20+KFaLv+71bUJeQ==", + "license": "MIT", + "dependencies": { + "scheduler": "^0.27.0" + }, + "peerDependencies": { + "react": "^19.2.4" + } + }, + "node_modules/react-fast-compare": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/react-fast-compare/-/react-fast-compare-3.2.2.tgz", + "integrity": "sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ==", + "license": "MIT" + }, + "node_modules/react-helmet-async": { + "name": "@slorber/react-helmet-async", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz", + "integrity": "sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A==", + "license": "Apache-2.0", + "dependencies": { + "@babel/runtime": "^7.12.5", + "invariant": "^2.2.4", + "prop-types": "^15.7.2", + "react-fast-compare": "^3.2.0", + "shallowequal": "^1.1.0" + }, + "peerDependencies": { + "react": "^16.6.0 || ^17.0.0 || ^18.0.0 || ^19.0.0", + "react-dom": "^16.6.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" + } + }, + "node_modules/react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "license": "MIT" + }, + "node_modules/react-json-view-lite": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz", + "integrity": "sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/react-loadable": { + "name": "@docusaurus/react-loadable", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", + "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", + "license": "MIT", + "dependencies": { + "@types/react": "*" + }, + "peerDependencies": { + "react": "*" + } + }, + "node_modules/react-loadable-ssr-addon-v5-slorber": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.3.tgz", + "integrity": "sha512-GXfh9VLwB5ERaCsU6RULh7tkemeX15aNh6wuMEBtfdyMa7fFG8TXrhXlx1SoEK2Ty/l6XIkzzYIQmyaWW3JgdQ==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.10.3" + }, + "engines": { + "node": ">=10.13.0" + }, + "peerDependencies": { + "react-loadable": "*", + "webpack": ">=4.41.1 || 5.x" + } + }, + "node_modules/react-router": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", + "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.12.13", + "history": "^4.9.0", + "hoist-non-react-statics": "^3.1.0", + "loose-envify": "^1.3.1", + "path-to-regexp": "^1.7.0", + "prop-types": "^15.6.2", + "react-is": "^16.6.0", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0" + }, + "peerDependencies": { + "react": ">=15" + } + }, + "node_modules/react-router-config": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/react-router-config/-/react-router-config-5.1.1.tgz", + "integrity": "sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.1.2" + }, + "peerDependencies": { + "react": ">=15", + "react-router": ">=5" + } + }, + "node_modules/react-router-dom": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-5.3.4.tgz", + "integrity": "sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.12.13", + "history": "^4.9.0", + "loose-envify": "^1.3.1", + "prop-types": "^15.6.2", + "react-router": "5.3.4", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0" + }, + "peerDependencies": { + "react": ">=15" + } + }, + "node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/readdirp": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", + "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "license": "MIT", + "dependencies": { + "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/recma-build-jsx": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-build-jsx/-/recma-build-jsx-1.0.0.tgz", + "integrity": "sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-util-build-jsx": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-jsx": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/recma-jsx/-/recma-jsx-1.0.1.tgz", + "integrity": "sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w==", + "license": "MIT", + "dependencies": { + "acorn-jsx": "^5.0.0", + "estree-util-to-js": "^2.0.0", + "recma-parse": "^1.0.0", + "recma-stringify": "^1.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + }, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/recma-parse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-parse/-/recma-parse-1.0.0.tgz", + "integrity": "sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "esast-util-from-js": "^2.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-stringify": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-stringify/-/recma-stringify-1.0.0.tgz", + "integrity": "sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-util-to-js": "^2.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/reflect-metadata": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz", + "integrity": "sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q==", + "license": "Apache-2.0" + }, + "node_modules/regenerate": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", + "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", + "license": "MIT" + }, + "node_modules/regenerate-unicode-properties": { + "version": "10.2.2", + "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz", + "integrity": "sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g==", + "license": "MIT", + "dependencies": { + "regenerate": "^1.4.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/regexpu-core": { + "version": "6.4.0", + "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.4.0.tgz", + "integrity": "sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA==", + "license": "MIT", + "dependencies": { + "regenerate": "^1.4.2", + "regenerate-unicode-properties": "^10.2.2", + "regjsgen": "^0.8.0", + "regjsparser": "^0.13.0", + "unicode-match-property-ecmascript": "^2.0.0", + "unicode-match-property-value-ecmascript": "^2.2.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/registry-auth-token": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.1.1.tgz", + "integrity": "sha512-P7B4+jq8DeD2nMsAcdfaqHbssgHtZ7Z5+++a5ask90fvmJ8p5je4mOa+wzu+DB4vQ5tdJV/xywY+UnVFeQLV5Q==", + "license": "MIT", + "dependencies": { + "@pnpm/npm-conf": "^3.0.2" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/registry-url": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", + "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", + "license": "MIT", + "dependencies": { + "rc": "1.2.8" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/regjsgen": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/regjsgen/-/regjsgen-0.8.0.tgz", + "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==", + "license": "MIT" + }, + "node_modules/regjsparser": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.0.tgz", + "integrity": "sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q==", + "license": "BSD-2-Clause", + "dependencies": { + "jsesc": "~3.1.0" + }, + "bin": { + "regjsparser": "bin/parser" + } + }, + "node_modules/rehype-raw": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/rehype-raw/-/rehype-raw-7.0.0.tgz", + "integrity": "sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-raw": "^9.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-recma": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/rehype-recma/-/rehype-recma-1.0.0.tgz", + "integrity": "sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "hast-util-to-estree": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/relateurl": { + "version": "0.2.7", + "resolved": "https://registry.npmjs.org/relateurl/-/relateurl-0.2.7.tgz", + "integrity": "sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog==", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/remark-directive": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/remark-directive/-/remark-directive-3.0.1.tgz", + "integrity": "sha512-gwglrEQEZcZYgVyG1tQuA+h58EZfq5CSULw7J90AFuCTyib1thgHPoqQ+h9iFvU6R+vnZ5oNFQR5QKgGpk741A==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-directive": "^3.0.0", + "micromark-extension-directive": "^3.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-emoji": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/remark-emoji/-/remark-emoji-4.0.1.tgz", + "integrity": "sha512-fHdvsTR1dHkWKev9eNyhTo4EFwbUvJ8ka9SgeWkMPYFX4WoI7ViVBms3PjlQYgw5TLvNQso3GUB/b/8t3yo+dg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.2", + "emoticon": "^4.0.1", + "mdast-util-find-and-replace": "^3.0.1", + "node-emoji": "^2.1.0", + "unified": "^11.0.4" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + } + }, + "node_modules/remark-frontmatter": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-5.0.0.tgz", + "integrity": "sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-frontmatter": "^2.0.0", + "micromark-extension-frontmatter": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-gfm": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/remark-gfm/-/remark-gfm-4.0.1.tgz", + "integrity": "sha512-1quofZ2RQ9EWdeN34S79+KExV1764+wCUGop5CPL1WGdD0ocPpu91lzPGbwWMECpEpd42kJGQwzRfyov9j4yNg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-gfm": "^3.0.0", + "micromark-extension-gfm": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-stringify": "^11.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-mdx": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/remark-mdx/-/remark-mdx-3.1.1.tgz", + "integrity": "sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg==", + "license": "MIT", + "dependencies": { + "mdast-util-mdx": "^3.0.0", + "micromark-extension-mdxjs": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-parse": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-11.0.0.tgz", + "integrity": "sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-rehype": { + "version": "11.1.2", + "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-11.1.2.tgz", + "integrity": "sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "mdast-util-to-hast": "^13.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-stringify": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-11.0.0.tgz", + "integrity": "sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-to-markdown": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/renderkid": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/renderkid/-/renderkid-3.0.0.tgz", + "integrity": "sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg==", + "license": "MIT", + "dependencies": { + "css-select": "^4.1.3", + "dom-converter": "^0.2.0", + "htmlparser2": "^6.1.0", + "lodash": "^4.17.21", + "strip-ansi": "^6.0.1" + } + }, + "node_modules/renderkid/node_modules/css-select": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-4.3.0.tgz", + "integrity": "sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.0.1", + "domhandler": "^4.3.1", + "domutils": "^2.8.0", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/renderkid/node_modules/dom-serializer": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.4.1.tgz", + "integrity": "sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==", + "license": "MIT", + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.2.0", + "entities": "^2.0.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/domhandler": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.3.1.tgz", + "integrity": "sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==", + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.2.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/domutils": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", + "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^1.0.1", + "domelementtype": "^2.2.0", + "domhandler": "^4.2.0" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/entities": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", + "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", + "license": "BSD-2-Clause", + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/htmlparser2": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz", + "integrity": "sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.0.0", + "domutils": "^2.5.2", + "entities": "^2.0.0" + } + }, + "node_modules/repeat-string": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", + "integrity": "sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==", + "license": "MIT", + "engines": { + "node": ">=0.10" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-like": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/require-like/-/require-like-0.1.2.tgz", + "integrity": "sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A==", + "engines": { + "node": "*" + } + }, + "node_modules/requires-port": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", + "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", + "license": "MIT" + }, + "node_modules/resolve": { + "version": "1.22.11", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", + "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", + "license": "MIT", + "dependencies": { + "is-core-module": "^2.16.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-alpn": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", + "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==", + "license": "MIT" + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/resolve-pathname": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz", + "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==", + "license": "MIT" + }, + "node_modules/responselike": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/responselike/-/responselike-3.0.0.tgz", + "integrity": "sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg==", + "license": "MIT", + "dependencies": { + "lowercase-keys": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/retry": { + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", + "integrity": "sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rtlcss": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/rtlcss/-/rtlcss-4.3.0.tgz", + "integrity": "sha512-FI+pHEn7Wc4NqKXMXFM+VAYKEj/mRIcW4h24YVwVtyjI+EqGrLc2Hx/Ny0lrZ21cBWU2goLy36eqMcNj3AQJig==", + "license": "MIT", + "dependencies": { + "escalade": "^3.1.1", + "picocolors": "^1.0.0", + "postcss": "^8.4.21", + "strip-json-comments": "^3.1.1" + }, + "bin": { + "rtlcss": "bin/rtlcss.js" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/run-applescript": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/run-applescript/-/run-applescript-7.1.0.tgz", + "integrity": "sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "license": "MIT" + }, + "node_modules/sax": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.6.0.tgz", + "integrity": "sha512-6R3J5M4AcbtLUdZmRv2SygeVaM7IhrLXu9BmnOGmmACak8fiUtOsYNWUS4uK7upbmHIBbLBeFeI//477BKLBzA==", + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=11.0.0" + } + }, + "node_modules/scheduler": { + "version": "0.27.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.27.0.tgz", + "integrity": "sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q==", + "license": "MIT" + }, + "node_modules/schema-dts": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/schema-dts/-/schema-dts-1.1.5.tgz", + "integrity": "sha512-RJr9EaCmsLzBX2NDiO5Z3ux2BVosNZN5jo0gWgsyKvxKIUL5R3swNvoorulAeL9kLB0iTSX7V6aokhla2m7xbg==", + "license": "Apache-2.0" + }, + "node_modules/schema-utils": { + "version": "4.3.3", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-4.3.3.tgz", + "integrity": "sha512-eflK8wEtyOE6+hsaRVPxvUKYCpRgzLqDTb8krvAsRIwOGlHoSgYLgBXoubGgLd2fT41/OUYdb48v4k4WWHQurA==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.9", + "ajv": "^8.9.0", + "ajv-formats": "^2.1.1", + "ajv-keywords": "^5.1.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/search-insights": { + "version": "2.17.3", + "resolved": "https://registry.npmjs.org/search-insights/-/search-insights-2.17.3.tgz", + "integrity": "sha512-RQPdCYTa8A68uM2jwxoY842xDhvx3E5LFL1LxvxCNMev4o5mLuokczhzjAgGwUZBAmOKZknArSxLKmXtIi2AxQ==", + "license": "MIT", + "peer": true + }, + "node_modules/section-matter": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz", + "integrity": "sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==", + "license": "MIT", + "dependencies": { + "extend-shallow": "^2.0.1", + "kind-of": "^6.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/select-hose": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/select-hose/-/select-hose-2.0.0.tgz", + "integrity": "sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg==", + "license": "MIT" + }, + "node_modules/selfsigned": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/selfsigned/-/selfsigned-5.5.0.tgz", + "integrity": "sha512-ftnu3TW4+3eBfLRFnDEkzGxSF/10BJBkaLJuBHZX0kiPS7bRdlpZGu6YGt4KngMkdTwJE6MbjavFpqHvqVt+Ew==", + "license": "MIT", + "dependencies": { + "@peculiar/x509": "^1.14.2", + "pkijs": "^3.3.3" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/semver": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", + "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver-diff": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", + "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", + "license": "MIT", + "dependencies": { + "semver": "^7.3.5" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/send": { + "version": "0.19.2", + "resolved": "https://registry.npmjs.org/send/-/send-0.19.2.tgz", + "integrity": "sha512-VMbMxbDeehAxpOtWJXlcUS5E8iXh6QmN+BkRX1GARS3wRaXEEgzCcB10gTQazO42tpNIya8xIyNx8fll1OFPrg==", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "~0.5.2", + "http-errors": "~2.0.1", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "~2.4.1", + "range-parser": "~1.2.1", + "statuses": "~2.0.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/send/node_modules/debug/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/send/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serialize-javascript": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", + "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", + "license": "BSD-3-Clause", + "dependencies": { + "randombytes": "^2.1.0" + } + }, + "node_modules/serve-handler": { + "version": "6.1.7", + "resolved": "https://registry.npmjs.org/serve-handler/-/serve-handler-6.1.7.tgz", + "integrity": "sha512-CinAq1xWb0vR3twAv9evEU8cNWkXCb9kd5ePAHUKJBkOsUpR1wt/CvGdeca7vqumL1U5cSaeVQ6zZMxiJ3yWsg==", + "license": "MIT", + "dependencies": { + "bytes": "3.0.0", + "content-disposition": "0.5.2", + "mime-types": "2.1.18", + "minimatch": "3.1.5", + "path-is-inside": "1.0.2", + "path-to-regexp": "3.3.0", + "range-parser": "1.2.0" + } + }, + "node_modules/serve-handler/node_modules/path-to-regexp": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-3.3.0.tgz", + "integrity": "sha512-qyCH421YQPS2WFDxDjftfc1ZR5WKQzVzqsp4n9M2kQhVOo/ByahFoUNJfl58kOcEGfQ//7weFTDhm+ss8Ecxgw==", + "license": "MIT" + }, + "node_modules/serve-index": { + "version": "1.9.2", + "resolved": "https://registry.npmjs.org/serve-index/-/serve-index-1.9.2.tgz", + "integrity": "sha512-KDj11HScOaLmrPxl70KYNW1PksP4Nb/CLL2yvC+Qd2kHMPEEpfc4Re2e4FOay+bC/+XQl/7zAcWON3JVo5v3KQ==", + "license": "MIT", + "dependencies": { + "accepts": "~1.3.8", + "batch": "0.6.1", + "debug": "2.6.9", + "escape-html": "~1.0.3", + "http-errors": "~1.8.0", + "mime-types": "~2.1.35", + "parseurl": "~1.3.3" + }, + "engines": { + "node": ">= 0.8.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/serve-index/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/serve-index/node_modules/depd": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", + "integrity": "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/http-errors": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.8.1.tgz", + "integrity": "sha512-Kpk9Sm7NmI+RHhnj6OIWDI1d6fIoFAtFt9RLaTMRlg/8w49juAStsrBgp0Dp4OdxdVbRIeKhtCUvoi/RuAhO4g==", + "license": "MIT", + "dependencies": { + "depd": "~1.1.2", + "inherits": "2.0.4", + "setprototypeof": "1.2.0", + "statuses": ">= 1.5.0 < 2", + "toidentifier": "1.0.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/serve-index/node_modules/statuses": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", + "integrity": "sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-static": { + "version": "1.16.3", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.3.tgz", + "integrity": "sha512-x0RTqQel6g5SY7Lg6ZreMmsOzncHFU7nhnRWkKgWuMTu5NN0DR5oruckMqRvacAN9d5w6ARnRBXl9xhDCgfMeA==", + "license": "MIT", + "dependencies": { + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "~0.19.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", + "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", + "license": "ISC" + }, + "node_modules/shallow-clone": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", + "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", + "license": "MIT", + "dependencies": { + "kind-of": "^6.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shallowequal": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz", + "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==", + "license": "MIT" + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "license": "MIT", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/shell-quote": { + "version": "1.8.3", + "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.3.tgz", + "integrity": "sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", + "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "license": "ISC" + }, + "node_modules/sirv": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/sirv/-/sirv-2.0.4.tgz", + "integrity": "sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==", + "license": "MIT", + "dependencies": { + "@polka/url": "^1.0.0-next.24", + "mrmime": "^2.0.0", + "totalist": "^3.0.0" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/sisteransi": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", + "license": "MIT" + }, + "node_modules/sitemap": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/sitemap/-/sitemap-7.1.3.tgz", + "integrity": "sha512-tAjEd+wt/YwnEbfNB2ht51ybBJxbEWwe5ki/Z//Wh0rpBFTCUSj46GnxUKEWzhfuJTsee8x3lybHxFgUMig2hw==", + "license": "MIT", + "dependencies": { + "@types/node": "^17.0.5", + "@types/sax": "^1.2.1", + "arg": "^5.0.0", + "sax": "^1.2.4" + }, + "bin": { + "sitemap": "dist/cli.js" + }, + "engines": { + "node": ">=12.0.0", + "npm": ">=5.6.0" + } + }, + "node_modules/sitemap/node_modules/@types/node": { + "version": "17.0.45", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.45.tgz", + "integrity": "sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==", + "license": "MIT" + }, + "node_modules/skin-tone": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/skin-tone/-/skin-tone-2.0.0.tgz", + "integrity": "sha512-kUMbT1oBJCpgrnKoSr0o6wPtvRWT9W9UKvGLwfJYO2WuahZRHOpEyL1ckyMGgMWh0UdpmaoFqKKD29WTomNEGA==", + "license": "MIT", + "dependencies": { + "unicode-emoji-modifier-base": "^1.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/snake-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", + "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", + "license": "MIT", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/sockjs": { + "version": "0.3.24", + "resolved": "https://registry.npmjs.org/sockjs/-/sockjs-0.3.24.tgz", + "integrity": "sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ==", + "license": "MIT", + "dependencies": { + "faye-websocket": "^0.11.3", + "uuid": "^8.3.2", + "websocket-driver": "^0.7.4" + } + }, + "node_modules/sort-css-media-queries": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/sort-css-media-queries/-/sort-css-media-queries-2.2.0.tgz", + "integrity": "sha512-0xtkGhWCC9MGt/EzgnvbbbKhqWjl1+/rncmhTh5qCpbYguXh6S/qwePfv/JQ8jePXXmqingylxoC49pCkSPIbA==", + "license": "MIT", + "engines": { + "node": ">= 6.3.0" + } + }, + "node_modules/source-map": { + "version": "0.7.6", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", + "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", + "license": "BSD-3-Clause", + "engines": { + "node": ">= 12" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.21", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", + "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "license": "MIT", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/source-map-support/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/space-separated-tokens": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", + "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/spdy": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/spdy/-/spdy-4.0.2.tgz", + "integrity": "sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA==", + "license": "MIT", + "dependencies": { + "debug": "^4.1.0", + "handle-thing": "^2.0.0", + "http-deceiver": "^1.2.7", + "select-hose": "^2.0.0", + "spdy-transport": "^3.0.0" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/spdy-transport": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/spdy-transport/-/spdy-transport-3.0.0.tgz", + "integrity": "sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw==", + "license": "MIT", + "dependencies": { + "debug": "^4.1.0", + "detect-node": "^2.0.4", + "hpack.js": "^2.1.6", + "obuf": "^1.1.2", + "readable-stream": "^3.0.6", + "wbuf": "^1.7.3" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "license": "BSD-3-Clause" + }, + "node_modules/srcset": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/srcset/-/srcset-4.0.0.tgz", + "integrity": "sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/statuses": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", + "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/std-env": { + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", + "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "license": "MIT" + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "license": "MIT", + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/string-width/node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/string-width/node_modules/strip-ansi": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.2.2" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/stringify-entities": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", + "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", + "license": "MIT", + "dependencies": { + "character-entities-html4": "^2.0.0", + "character-entities-legacy": "^3.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/stringify-object": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", + "integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==", + "license": "BSD-2-Clause", + "dependencies": { + "get-own-enumerable-property-symbols": "^3.0.0", + "is-obj": "^1.0.1", + "is-regexp": "^1.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/strip-bom-string/-/strip-bom-string-1.0.0.tgz", + "integrity": "sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/style-to-js": { + "version": "1.1.21", + "resolved": "https://registry.npmjs.org/style-to-js/-/style-to-js-1.1.21.tgz", + "integrity": "sha512-RjQetxJrrUJLQPHbLku6U/ocGtzyjbJMP9lCNK7Ag0CNh690nSH8woqWH9u16nMjYBAok+i7JO1NP2pOy8IsPQ==", + "license": "MIT", + "dependencies": { + "style-to-object": "1.0.14" + } + }, + "node_modules/style-to-object": { + "version": "1.0.14", + "resolved": "https://registry.npmjs.org/style-to-object/-/style-to-object-1.0.14.tgz", + "integrity": "sha512-LIN7rULI0jBscWQYaSswptyderlarFkjQ+t79nzty8tcIAceVomEVlLzH5VP4Cmsv6MtKhs7qaAiwlcp+Mgaxw==", + "license": "MIT", + "dependencies": { + "inline-style-parser": "0.2.7" + } + }, + "node_modules/stylehacks": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-6.1.1.tgz", + "integrity": "sha512-gSTTEQ670cJNoaeIp9KX6lZmm8LJ3jPB5yJmX8Zq/wQxOsAFXV3qjWzHas3YYk1qesuVIyYWWUpZ0vSE/dTSGg==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/svg-parser": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/svg-parser/-/svg-parser-2.0.4.tgz", + "integrity": "sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ==", + "license": "MIT" + }, + "node_modules/svgo": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/svgo/-/svgo-3.3.3.tgz", + "integrity": "sha512-+wn7I4p7YgJhHs38k2TNjy1vCfPIfLIJWR5MnCStsN8WuuTcBnRKcMHQLMM2ijxGZmDoZwNv8ipl5aTTen62ng==", + "license": "MIT", + "dependencies": { + "commander": "^7.2.0", + "css-select": "^5.1.0", + "css-tree": "^2.3.1", + "css-what": "^6.1.0", + "csso": "^5.0.5", + "picocolors": "^1.0.0", + "sax": "^1.5.0" + }, + "bin": { + "svgo": "bin/svgo" + }, + "engines": { + "node": ">=14.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/svgo" + } + }, + "node_modules/svgo/node_modules/commander": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", + "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, + "node_modules/tapable": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.3.2.tgz", + "integrity": "sha512-1MOpMXuhGzGL5TTCZFItxCc0AARf1EZFQkGqMm7ERKj8+Hgr5oLvJOVFcC+lRmR8hCe2S3jC4T5D7Vg/d7/fhA==", + "license": "MIT", + "engines": { + "node": ">=6" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/terser": { + "version": "5.46.1", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.46.1.tgz", + "integrity": "sha512-vzCjQO/rgUuK9sf8VJZvjqiqiHFaZLnOiimmUuOKODxWL8mm/xua7viT7aqX7dgPY60otQjUotzFMmCB4VdmqQ==", + "license": "BSD-2-Clause", + "dependencies": { + "@jridgewell/source-map": "^0.3.3", + "acorn": "^8.15.0", + "commander": "^2.20.0", + "source-map-support": "~0.5.20" + }, + "bin": { + "terser": "bin/terser" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/terser-webpack-plugin": { + "version": "5.4.0", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.4.0.tgz", + "integrity": "sha512-Bn5vxm48flOIfkdl5CaD2+1CiUVbonWQ3KQPyP7/EuIl9Gbzq/gQFOzaMFUEgVjB1396tcK0SG8XcNJ/2kDH8g==", + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.25", + "jest-worker": "^27.4.5", + "schema-utils": "^4.3.0", + "terser": "^5.31.1" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "esbuild": { + "optional": true + }, + "uglify-js": { + "optional": true + } + } + }, + "node_modules/terser-webpack-plugin/node_modules/jest-worker": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", + "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", + "license": "MIT", + "dependencies": { + "@types/node": "*", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/terser-webpack-plugin/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/terser/node_modules/commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "license": "MIT" + }, + "node_modules/thingies": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/thingies/-/thingies-2.6.0.tgz", + "integrity": "sha512-rMHRjmlFLM1R96UYPvpmnc3LYtdFrT33JIB7L9hetGue1qAPfn1N2LJeEjxUSidu1Iku+haLZXDuEXUHNGO/lg==", + "license": "MIT", + "engines": { + "node": ">=10.18" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "^2" + } + }, + "node_modules/thunky": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/thunky/-/thunky-1.1.0.tgz", + "integrity": "sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA==", + "license": "MIT" + }, + "node_modules/tiny-invariant": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.3.tgz", + "integrity": "sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==", + "license": "MIT" + }, + "node_modules/tiny-warning": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", + "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==", + "license": "MIT" + }, + "node_modules/tinypool": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", + "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", + "license": "MIT", + "engines": { + "node": "^18.0.0 || >=20.0.0" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/toidentifier": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", + "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", + "license": "MIT", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/totalist": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/totalist/-/totalist-3.0.1.tgz", + "integrity": "sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/tree-dump": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/tree-dump/-/tree-dump-1.1.0.tgz", + "integrity": "sha512-rMuvhU4MCDbcbnleZTFezWsaZXRFemSqAM+7jPnzUl1fo9w3YEKOxAeui0fz3OI4EU4hf23iyA7uQRVko+UaBA==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/trim-lines": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", + "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/trough": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/trough/-/trough-2.2.0.tgz", + "integrity": "sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, + "node_modules/tsyringe": { + "version": "4.10.0", + "resolved": "https://registry.npmjs.org/tsyringe/-/tsyringe-4.10.0.tgz", + "integrity": "sha512-axr3IdNuVIxnaK5XGEUFTu3YmAQ6lllgrvqfEoR16g/HGnYY/6We4oWENtAnzK6/LpJ2ur9PAb80RBt7/U4ugw==", + "license": "MIT", + "dependencies": { + "tslib": "^1.9.3" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/tsyringe/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "license": "0BSD" + }, + "node_modules/type-fest": { + "version": "2.19.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz", + "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "license": "MIT", + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/typedarray-to-buffer": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", + "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", + "license": "MIT", + "dependencies": { + "is-typedarray": "^1.0.0" + } + }, + "node_modules/typescript": { + "version": "5.6.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", + "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", + "devOptional": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", + "integrity": "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w==", + "license": "MIT" + }, + "node_modules/unicode-canonical-property-names-ecmascript": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz", + "integrity": "sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-emoji-modifier-base": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unicode-emoji-modifier-base/-/unicode-emoji-modifier-base-1.0.0.tgz", + "integrity": "sha512-yLSH4py7oFH3oG/9K+XWrz1pSi3dfUrWEnInbxMfArOfc1+33BlGPQtLsOYwvdMy11AwUBetYuaRxSPqgkq+8g==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-ecmascript": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", + "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", + "license": "MIT", + "dependencies": { + "unicode-canonical-property-names-ecmascript": "^2.0.0", + "unicode-property-aliases-ecmascript": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-value-ecmascript": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz", + "integrity": "sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-property-aliases-ecmascript": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz", + "integrity": "sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unified": { + "version": "11.0.5", + "resolved": "https://registry.npmjs.org/unified/-/unified-11.0.5.tgz", + "integrity": "sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "bail": "^2.0.0", + "devlop": "^1.0.0", + "extend": "^3.0.0", + "is-plain-obj": "^4.0.0", + "trough": "^2.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unique-string": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", + "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", + "license": "MIT", + "dependencies": { + "crypto-random-string": "^4.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/unist-util-is": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.1.tgz", + "integrity": "sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", + "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position-from-estree/-/unist-util-position-from-estree-2.0.0.tgz", + "integrity": "sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-stringify-position": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", + "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.1.0.tgz", + "integrity": "sha512-m+vIdyeCOpdr/QeQCu2EzxX/ohgS8KbnPDgFni4dQsfSCtpz8UqDyY5GjRru8PDKuYn7Fq19j1CQ+nJSsGKOzg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-parents": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.2.tgz", + "integrity": "sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/update-browserslist-db": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", + "integrity": "sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "escalade": "^3.2.0", + "picocolors": "^1.1.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/update-notifier": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", + "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", + "license": "BSD-2-Clause", + "dependencies": { + "boxen": "^7.0.0", + "chalk": "^5.0.1", + "configstore": "^6.0.0", + "has-yarn": "^3.0.0", + "import-lazy": "^4.0.0", + "is-ci": "^3.0.1", + "is-installed-globally": "^0.4.0", + "is-npm": "^6.0.0", + "is-yarn-global": "^0.4.0", + "latest-version": "^7.0.0", + "pupa": "^3.1.0", + "semver": "^7.3.7", + "semver-diff": "^4.0.0", + "xdg-basedir": "^5.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/yeoman/update-notifier?sponsor=1" + } + }, + "node_modules/update-notifier/node_modules/boxen": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.1.1.tgz", + "integrity": "sha512-2hCgjEmP8YLWQ130n2FerGv7rYpfBmnmp9Uy2Le1vge6X3gZIfSmEzP5QTDElFxcvVcXlEn8Aq6MU/PZygIOog==", + "license": "MIT", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^7.0.1", + "chalk": "^5.2.0", + "cli-boxes": "^3.0.0", + "string-width": "^5.1.2", + "type-fest": "^2.13.0", + "widest-line": "^4.0.1", + "wrap-ansi": "^8.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/update-notifier/node_modules/camelcase": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.1.tgz", + "integrity": "sha512-xlx1yCK2Oc1APsPXDL2LdlNP6+uu8OCDdhOBSVT279M/S+y75O30C2VuD8T2ogdePBBl7PfPF4504tnLgX3zfw==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/update-notifier/node_modules/chalk": { + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", + "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", + "license": "MIT", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "license": "BSD-2-Clause", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/url-loader": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/url-loader/-/url-loader-4.1.1.tgz", + "integrity": "sha512-3BTV812+AVHHOJQO8O5MkWgZ5aosP7GnROJwvzLS9hWDj00lZ6Z0wNak423Lp9PBZN05N+Jk/N5Si8jRAlGyWA==", + "license": "MIT", + "dependencies": { + "loader-utils": "^2.0.0", + "mime-types": "^2.1.27", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "file-loader": "*", + "webpack": "^4.0.0 || ^5.0.0" + }, + "peerDependenciesMeta": { + "file-loader": { + "optional": true + } + } + }, + "node_modules/url-loader/node_modules/ajv": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", + "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/url-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "license": "MIT", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/url-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "license": "MIT" + }, + "node_modules/url-loader/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/url-loader/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/url-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "license": "MIT" + }, + "node_modules/utila": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/utila/-/utila-0.4.0.tgz", + "integrity": "sha512-Z0DbgELS9/L/75wZbro8xAnT50pBVFQZ+hUEueGDU5FN51YSCYM+jdxsfCiHjwNP/4LCDD0i/graKpeBnOXKRA==", + "license": "MIT" + }, + "node_modules/utility-types": { + "version": "3.11.0", + "resolved": "https://registry.npmjs.org/utility-types/-/utility-types-3.11.0.tgz", + "integrity": "sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", + "license": "MIT", + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/uuid": { + "version": "8.3.2", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", + "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", + "license": "MIT", + "bin": { + "uuid": "dist/bin/uuid" + } + }, + "node_modules/value-equal": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/value-equal/-/value-equal-1.0.1.tgz", + "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==", + "license": "MIT" + }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/vfile": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", + "integrity": "sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-location": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-5.0.3.tgz", + "integrity": "sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-message": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.3.tgz", + "integrity": "sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/watchpack": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.5.1.tgz", + "integrity": "sha512-Zn5uXdcFNIA1+1Ei5McRd+iRzfhENPCe7LeABkJtNulSxjma+l7ltNx55BWZkRlwRnpOgHqxnjyaDgJnNXnqzg==", + "license": "MIT", + "dependencies": { + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.1.2" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/wbuf": { + "version": "1.7.3", + "resolved": "https://registry.npmjs.org/wbuf/-/wbuf-1.7.3.tgz", + "integrity": "sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA==", + "license": "MIT", + "dependencies": { + "minimalistic-assert": "^1.0.0" + } + }, + "node_modules/web-namespaces": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/web-namespaces/-/web-namespaces-2.0.1.tgz", + "integrity": "sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/webpack": { + "version": "5.105.4", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.105.4.tgz", + "integrity": "sha512-jTywjboN9aHxFlToqb0K0Zs9SbBoW4zRUlGzI2tYNxVYcEi/IPpn+Xi4ye5jTLvX2YeLuic/IvxNot+Q1jMoOw==", + "license": "MIT", + "dependencies": { + "@types/eslint-scope": "^3.7.7", + "@types/estree": "^1.0.8", + "@types/json-schema": "^7.0.15", + "@webassemblyjs/ast": "^1.14.1", + "@webassemblyjs/wasm-edit": "^1.14.1", + "@webassemblyjs/wasm-parser": "^1.14.1", + "acorn": "^8.16.0", + "acorn-import-phases": "^1.0.3", + "browserslist": "^4.28.1", + "chrome-trace-event": "^1.0.2", + "enhanced-resolve": "^5.20.0", + "es-module-lexer": "^2.0.0", + "eslint-scope": "5.1.1", + "events": "^3.2.0", + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.2.11", + "json-parse-even-better-errors": "^2.3.1", + "loader-runner": "^4.3.1", + "mime-types": "^2.1.27", + "neo-async": "^2.6.2", + "schema-utils": "^4.3.3", + "tapable": "^2.3.0", + "terser-webpack-plugin": "^5.3.17", + "watchpack": "^2.5.1", + "webpack-sources": "^3.3.4" + }, + "bin": { + "webpack": "bin/webpack.js" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependenciesMeta": { + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-bundle-analyzer": { + "version": "4.10.2", + "resolved": "https://registry.npmjs.org/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.2.tgz", + "integrity": "sha512-vJptkMm9pk5si4Bv922ZbKLV8UTT4zib4FPgXMhgzUny0bfDDkLXAVQs3ly3fS4/TN9ROFtb0NFrm04UXFE/Vw==", + "license": "MIT", + "dependencies": { + "@discoveryjs/json-ext": "0.5.7", + "acorn": "^8.0.4", + "acorn-walk": "^8.0.0", + "commander": "^7.2.0", + "debounce": "^1.2.1", + "escape-string-regexp": "^4.0.0", + "gzip-size": "^6.0.0", + "html-escaper": "^2.0.2", + "opener": "^1.5.2", + "picocolors": "^1.0.0", + "sirv": "^2.0.3", + "ws": "^7.3.1" + }, + "bin": { + "webpack-bundle-analyzer": "lib/bin/analyzer.js" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/webpack-bundle-analyzer/node_modules/commander": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", + "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, + "node_modules/webpack-dev-middleware": { + "version": "7.4.5", + "resolved": "https://registry.npmjs.org/webpack-dev-middleware/-/webpack-dev-middleware-7.4.5.tgz", + "integrity": "sha512-uxQ6YqGdE4hgDKNf7hUiPXOdtkXvBJXrfEGYSx7P7LC8hnUYGK70X6xQXUvXeNyBDDcsiQXpG2m3G9vxowaEuA==", + "license": "MIT", + "dependencies": { + "colorette": "^2.0.10", + "memfs": "^4.43.1", + "mime-types": "^3.0.1", + "on-finished": "^2.4.1", + "range-parser": "^1.2.1", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 18.12.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + } + } + }, + "node_modules/webpack-dev-middleware/node_modules/mime-db": { + "version": "1.54.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", + "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack-dev-middleware/node_modules/mime-types": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.2.tgz", + "integrity": "sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A==", + "license": "MIT", + "dependencies": { + "mime-db": "^1.54.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/webpack-dev-middleware/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack-dev-server": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-5.2.3.tgz", + "integrity": "sha512-9Gyu2F7+bg4Vv+pjbovuYDhHX+mqdqITykfzdM9UyKqKHlsE5aAjRhR+oOEfXW5vBeu8tarzlJFIZva4ZjAdrQ==", + "license": "MIT", + "dependencies": { + "@types/bonjour": "^3.5.13", + "@types/connect-history-api-fallback": "^1.5.4", + "@types/express": "^4.17.25", + "@types/express-serve-static-core": "^4.17.21", + "@types/serve-index": "^1.9.4", + "@types/serve-static": "^1.15.5", + "@types/sockjs": "^0.3.36", + "@types/ws": "^8.5.10", + "ansi-html-community": "^0.0.8", + "bonjour-service": "^1.2.1", + "chokidar": "^3.6.0", + "colorette": "^2.0.10", + "compression": "^1.8.1", + "connect-history-api-fallback": "^2.0.0", + "express": "^4.22.1", + "graceful-fs": "^4.2.6", + "http-proxy-middleware": "^2.0.9", + "ipaddr.js": "^2.1.0", + "launch-editor": "^2.6.1", + "open": "^10.0.3", + "p-retry": "^6.2.0", + "schema-utils": "^4.2.0", + "selfsigned": "^5.5.0", + "serve-index": "^1.9.1", + "sockjs": "^0.3.24", + "spdy": "^4.0.2", + "webpack-dev-middleware": "^7.4.2", + "ws": "^8.18.0" + }, + "bin": { + "webpack-dev-server": "bin/webpack-dev-server.js" + }, + "engines": { + "node": ">= 18.12.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + }, + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-dev-server/node_modules/define-lazy-prop": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz", + "integrity": "sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/webpack-dev-server/node_modules/open": { + "version": "10.2.0", + "resolved": "https://registry.npmjs.org/open/-/open-10.2.0.tgz", + "integrity": "sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA==", + "license": "MIT", + "dependencies": { + "default-browser": "^5.2.1", + "define-lazy-prop": "^3.0.0", + "is-inside-container": "^1.0.0", + "wsl-utils": "^0.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/webpack-dev-server/node_modules/ws": { + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.20.0.tgz", + "integrity": "sha512-sAt8BhgNbzCtgGbt2OxmpuryO63ZoDk/sqaB/znQm94T4fCEsy/yV+7CdC1kJhOU9lboAEU7R3kquuycDoibVA==", + "license": "MIT", + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/webpack-merge": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-6.0.1.tgz", + "integrity": "sha512-hXXvrjtx2PLYx4qruKl+kyRSLc52V+cCvMxRjmKwoA+CBbbF5GfIBtR6kCvl0fYGqTUPKB+1ktVmTHqMOzgCBg==", + "license": "MIT", + "dependencies": { + "clone-deep": "^4.0.1", + "flat": "^5.0.2", + "wildcard": "^2.0.1" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/webpack-sources": { + "version": "3.3.4", + "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.3.4.tgz", + "integrity": "sha512-7tP1PdV4vF+lYPnkMR0jMY5/la2ub5Fc/8VQrrU+lXkiM6C4TjVfGw7iKfyhnTQOsD+6Q/iKw0eFciziRgD58Q==", + "license": "MIT", + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/webpack/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpackbar": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/webpackbar/-/webpackbar-6.0.1.tgz", + "integrity": "sha512-TnErZpmuKdwWBdMoexjio3KKX6ZtoKHRVvLIU0A47R0VVBDtx3ZyOJDktgYixhoJokZTYTt1Z37OkO9pnGJa9Q==", + "license": "MIT", + "dependencies": { + "ansi-escapes": "^4.3.2", + "chalk": "^4.1.2", + "consola": "^3.2.3", + "figures": "^3.2.0", + "markdown-table": "^2.0.0", + "pretty-time": "^1.1.0", + "std-env": "^3.7.0", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=14.21.3" + }, + "peerDependencies": { + "webpack": "3 || 4 || 5" + } + }, + "node_modules/webpackbar/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/webpackbar/node_modules/markdown-table": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-2.0.0.tgz", + "integrity": "sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A==", + "license": "MIT", + "dependencies": { + "repeat-string": "^1.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/webpackbar/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/webpackbar/node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/websocket-driver": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/websocket-driver/-/websocket-driver-0.7.4.tgz", + "integrity": "sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg==", + "license": "Apache-2.0", + "dependencies": { + "http-parser-js": ">=0.5.1", + "safe-buffer": ">=5.1.0", + "websocket-extensions": ">=0.1.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/websocket-extensions": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/websocket-extensions/-/websocket-extensions-0.1.4.tgz", + "integrity": "sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg==", + "license": "Apache-2.0", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/widest-line": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", + "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", + "license": "MIT", + "dependencies": { + "string-width": "^5.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/wildcard": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/wildcard/-/wildcard-2.0.1.tgz", + "integrity": "sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==", + "license": "MIT" + }, + "node_modules/wrap-ansi": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", + "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-styles": { + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/strip-ansi": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.2.2" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/write-file-atomic": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", + "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", + "license": "ISC", + "dependencies": { + "imurmurhash": "^0.1.4", + "is-typedarray": "^1.0.0", + "signal-exit": "^3.0.2", + "typedarray-to-buffer": "^3.1.5" + } + }, + "node_modules/ws": { + "version": "7.5.10", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz", + "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==", + "license": "MIT", + "engines": { + "node": ">=8.3.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/wsl-utils": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/wsl-utils/-/wsl-utils-0.1.0.tgz", + "integrity": "sha512-h3Fbisa2nKGPxCpm89Hk33lBLsnaGBvctQopaBSOW/uIs6FTe1ATyAnKFJrzVs9vpGdsTe73WF3V4lIsk4Gacw==", + "license": "MIT", + "dependencies": { + "is-wsl": "^3.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/wsl-utils/node_modules/is-wsl": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.1.tgz", + "integrity": "sha512-e6rvdUCiQCAuumZslxRJWR/Doq4VpPR82kqclvcS0efgt430SlGIk05vdCN58+VrzgtIcfNODjozVielycD4Sw==", + "license": "MIT", + "dependencies": { + "is-inside-container": "^1.0.0" + }, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/xdg-basedir": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", + "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/xml-js": { + "version": "1.6.11", + "resolved": "https://registry.npmjs.org/xml-js/-/xml-js-1.6.11.tgz", + "integrity": "sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g==", + "license": "MIT", + "dependencies": { + "sax": "^1.2.4" + }, + "bin": { + "xml-js": "bin/cli.js" + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "license": "ISC" + }, + "node_modules/yocto-queue": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", + "integrity": "sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==", + "license": "MIT", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/zwitch": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", + "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + } + } +} diff --git a/website/package.json b/website/package.json new file mode 100644 index 00000000000..452e8815d3d --- /dev/null +++ b/website/package.json @@ -0,0 +1,47 @@ +{ + "name": "website", + "version": "0.0.0", + "private": true, + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids", + "typecheck": "tsc" + }, + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "prism-react-renderer": "^2.3.0", + "react": "^19.0.0", + "react-dom": "^19.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", + "@docusaurus/types": "3.9.2", + "typescript": "~5.6.2" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" + ] + }, + "engines": { + "node": ">=20.0" + } +} diff --git a/website/scripts/__tests__/fixtures/fixture-expected-issues.md b/website/scripts/__tests__/fixtures/fixture-expected-issues.md new file mode 100644 index 00000000000..a27d856810c --- /dev/null +++ b/website/scripts/__tests__/fixtures/fixture-expected-issues.md @@ -0,0 +1,107 @@ +--- +sidebar_position: 1 +title: TestApi +--- + +# TestApi + +All URIs are relative to _http://localhost_ + +| Method | HTTP request | Description | +| --------------------------------------------------- | --------------- | ----------- | +| [**testMethod**](TestApi.md#testMethod) | **GET** /test/ | +| [**anotherOperation**](TestApi.md#anotherOperation) | **POST** /test/ | + +# testMethod + +> V1Pod testMethod() + +This tests various edge cases + +### Example + +```typescript +import { TestApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new TestApi(configuration); + +const request = {}; + +const data = await apiInstance.testMethod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +V1Pod + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +| ----------- | ------------ | ---------------- | +| **200** | OK | - | +| **401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# anotherOperation + +> string anotherOperation() + +Another operation with internal links + +### Example + +```typescript +import { TestApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new TestApi(configuration); + +const request = {}; + +const data = await apiInstance.anotherOperation(request); +console.log('API called successfully. Returned data:', data); +``` + +See [**testMethod**](TestApi.md#testMethod) for more details. + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +string + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +| ----------- | ------------ | ---------------- | +| **200** | OK | - | +| **401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) diff --git a/website/scripts/__tests__/fixtures/fixture-expected-small.md b/website/scripts/__tests__/fixtures/fixture-expected-small.md new file mode 100644 index 00000000000..c124b6f49e1 --- /dev/null +++ b/website/scripts/__tests__/fixtures/fixture-expected-small.md @@ -0,0 +1,58 @@ +--- +sidebar_position: 1 +title: VersionApi +--- + +# VersionApi + +All URIs are relative to _http://localhost_ + +| Method | HTTP request | Description | +| ------------------------------------ | ----------------- | ----------- | +| [**getCode**](VersionApi.md#getCode) | **GET** /version/ | + +# getCode + +> VersionInfo getCode() + +get the version information for this server + +### Example + +```typescript +import { createConfiguration, VersionApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new VersionApi(configuration); + +const request = {}; + +const data = await apiInstance.getCode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +VersionInfo + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +| ----------- | ------------ | ---------------- | +| **200** | OK | - | +| **401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) diff --git a/website/scripts/__tests__/fixtures/fixture-small.md b/website/scripts/__tests__/fixtures/fixture-small.md new file mode 100644 index 00000000000..4c7dc727589 --- /dev/null +++ b/website/scripts/__tests__/fixtures/fixture-small.md @@ -0,0 +1,57 @@ +# .VersionApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getCode**](VersionApi.md#getCode) | **GET** /version/ | + + +# **getCode** +> VersionInfo getCode() + +get the version information for this server + +### Example + + +```typescript +import { createConfiguration, VersionApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new VersionApi(configuration); + +const request = {}; + +const data = await apiInstance.getCode(request); +console.log('API called successfully. Returned data:', data); +``` + + +### Parameters +This endpoint does not need any parameter. + + +### Return type + +**VersionInfo** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + + diff --git a/website/scripts/__tests__/fixtures/fixture-with-issues.md b/website/scripts/__tests__/fixtures/fixture-with-issues.md new file mode 100644 index 00000000000..78788d071a7 --- /dev/null +++ b/website/scripts/__tests__/fixtures/fixture-with-issues.md @@ -0,0 +1,102 @@ +# .TestApi + +All URIs are relative to _http://localhost_ + +| Method | HTTP request | Description | +| --------------------------------------------------- | --------------- | ----------- | +| [**testMethod**](TestApi.md#testMethod) | **GET** /test/ | +| [**anotherOperation**](TestApi.md#anotherOperation) | **POST** /test/ | + +# **testMethod** + +> **V1Pod** testMethod() + +This tests various edge cases + +### Example + +```typescript +import { TestApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new TestApi(configuration); + +const request = {}; + +const data = await apiInstance.testMethod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**V1Pod** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +| ----------- | ------------ | ---------------- | +| **200** | OK | - | +| **401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) + +# **anotherOperation** + +> string anotherOperation() + +Another operation with internal links + +### Example + +```typescript +import { TestApi } from ''; + +const configuration = createConfiguration(); +const apiInstance = new TestApi(configuration); + +const request = {}; + +const data = await apiInstance.anotherOperation(request); +console.log('API called successfully. Returned data:', data); +``` + +See [**testMethod**](TestApi.md#testMethod) for more details. + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**string** + +### Authorization + +[BearerToken](README.md#BearerToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +| ----------- | ------------ | ---------------- | +| **200** | OK | - | +| **401** | Unauthorized | - | + +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) diff --git a/website/scripts/__tests__/transform.test.mjs b/website/scripts/__tests__/transform.test.mjs new file mode 100644 index 00000000000..c748cdd18fc --- /dev/null +++ b/website/scripts/__tests__/transform.test.mjs @@ -0,0 +1,141 @@ +import { test } from 'node:test'; +import * as assert from 'node:assert'; +import { readFileSync } from 'node:fs'; +import { resolve } from 'node:path'; +import { fileURLToPath } from 'node:url'; +import { dirname } from 'node:path'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = dirname(__filename); + +// Placeholder for the actual transform function (to be implemented in Task 5) +async function transformMarkdown(content) { + throw new Error('Transform function not yet implemented'); +} + +const fixturesDir = resolve(__dirname, 'fixtures'); + +test('Test 1: Frontmatter insertion', async (t) => { + const input = readFileSync(resolve(fixturesDir, 'fixture-small.md'), 'utf8'); + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-small.md'), 'utf8'); + + // Expected output should start with YAML frontmatter + assert.match( + expected, + /^---\nsidebar_position:.*?\ntitle:.*?\n---\n/, + 'Expected output should have frontmatter', + ); + // Input should NOT have frontmatter + assert.doesNotMatch(input, /^---/, 'Input should not have frontmatter'); +}); + +test('Test 2: Heading normalization - leading dot removal', async (t) => { + const input = readFileSync(resolve(fixturesDir, 'fixture-with-issues.md'), 'utf8'); + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-issues.md'), 'utf8'); + + // Input has leading dot in title + assert.match(input, /^# \.TestApi/, 'Input should have leading dot in title'); + // Expected has no leading dot (after frontmatter, there's a blank line then # TestApi) + assert.match(expected, /^# TestApi/m, 'Expected should not have leading dot after frontmatter'); + assert.doesNotMatch(expected, /\.TestApi/, 'Expected should not have any leading dots with TestApi'); +}); + +test('Test 3: Heading normalization - bold removal', async (t) => { + const input = readFileSync(resolve(fixturesDir, 'fixture-with-issues.md'), 'utf8'); + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-issues.md'), 'utf8'); + + // Input has bold heading + assert.match(input, /# \*\*testMethod\*\*/, 'Input should have bold heading'); + // Expected has no bold + assert.match(expected, /# testMethod\n/, 'Expected should remove bold from heading'); +}); + +test('Test 4: Import path replacement', async (t) => { + const input = readFileSync(resolve(fixturesDir, 'fixture-with-issues.md'), 'utf8'); + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-issues.md'), 'utf8'); + + // Input has empty import path + assert.match(input, /import { TestApi } from '';/, 'Input should have empty import path'); + // Expected has @kubernetes/client-node + assert.match( + expected, + /import { TestApi } from '@kubernetes\/client-node';/, + 'Expected should have correct import path', + ); +}); + +test('Test 5: Internal link rewriting', async (t) => { + const input = readFileSync(resolve(fixturesDir, 'fixture-with-issues.md'), 'utf8'); + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-issues.md'), 'utf8'); + + // Both should have links + assert.match(input, /\[.*?\]\(.*?\)/, 'Input should have markdown links'); + assert.match(expected, /\[.*?\]\(.*?\)/, 'Expected should have markdown links'); + + // Links in reference table should work + assert.match( + expected, + /\[\*\*testMethod\*\*\]\(TestApi\.md#testMethod\)/, + 'Expected should have correct method links', + ); +}); + +test('Test 6: Bold formatting in return types removed', async (t) => { + const input = readFileSync(resolve(fixturesDir, 'fixture-with-issues.md'), 'utf8'); + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-issues.md'), 'utf8'); + + // Input has bold return types + assert.match(input, /> \*\*V1Pod\*\* testMethod\(\)/, 'Input should have bold model name in return type'); + assert.match(input, /\*\*V1Pod\*\*/, 'Input should have bold model names'); + // Expected should remove bold formatting from return types + assert.match(expected, /> V1Pod testMethod\(\)/m, 'Expected should have unbolded return type in header'); + assert.match(expected, /### Return type\n\nV1Pod/m, 'Expected should have unbolded return type'); +}); + +test('Test 7: Footer patterns preserved', async (t) => { + const input = readFileSync(resolve(fixturesDir, 'fixture-with-issues.md'), 'utf8'); + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-issues.md'), 'utf8'); + + // Both should have footer links + assert.match(expected, /\[\[Back to top\]\]\(#\)/, 'Expected should preserve back-to-top link'); + assert.match( + expected, + /\[\[Back to API list\]\]\(README\.md#documentation-for-api-endpoints\)/, + 'Expected should preserve API list link', + ); +}); + +test('Test 8: Idempotency - transform should be stable', async (t) => { + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-small.md'), 'utf8'); + + // Expected output should already have frontmatter + assert.match(expected, /^---/, 'Expected should start with frontmatter'); + // Count frontmatter markers (should be exactly 2) + const markerCount = (expected.match(/^---/gm) || []).length; + assert.strictEqual( + markerCount, + 2, + 'Expected should have exactly 2 frontmatter markers (opening and closing)', + ); +}); + +test('Test 9: Empty/malformed input handling', async (t) => { + // Test with empty file + const emptyInput = ''; + assert.strictEqual(emptyInput, '', 'Empty input should be handled'); + + // Test with only whitespace + const whitespaceInput = ' \n\n \n'; + assert.strictEqual(whitespaceInput.trim(), '', 'Whitespace-only input should be handled'); +}); + +test('Test 10: Model reference formatting', async (t) => { + const input = readFileSync(resolve(fixturesDir, 'fixture-with-issues.md'), 'utf8'); + const expected = readFileSync(resolve(fixturesDir, 'fixture-expected-issues.md'), 'utf8'); + + // Input should have bold model reference in description + assert.match(input, /\*\*V1Pod\*\*/, 'Input should have bold model name'); + + // Expected should preserve model names but in correct context + assert.match(expected, /V1Pod/, 'Expected should have model name'); +}); diff --git a/website/scripts/api-group-map.json b/website/scripts/api-group-map.json new file mode 100644 index 00000000000..799cbe8cbcf --- /dev/null +++ b/website/scripts/api-group-map.json @@ -0,0 +1,327 @@ +{ + "AdmissionregistrationApi": { + "group": "Admissionregistration", + "version": "", + "category": "Cluster" + }, + "AdmissionregistrationV1Api": { + "group": "Admissionregistration", + "version": "v1", + "category": "Cluster" + }, + "AdmissionregistrationV1alpha1Api": { + "group": "Admissionregistration", + "version": "v1alpha1", + "category": "Cluster" + }, + "AdmissionregistrationV1beta1Api": { + "group": "Admissionregistration", + "version": "v1beta1", + "category": "Cluster" + }, + "ApiextensionsApi": { + "group": "Apiextensions", + "version": "", + "category": "Cluster" + }, + "ApiextensionsV1Api": { + "group": "Apiextensions", + "version": "v1", + "category": "Cluster" + }, + "ApiregistrationApi": { + "group": "Apiregistration", + "version": "", + "category": "Cluster" + }, + "ApiregistrationV1Api": { + "group": "Apiregistration", + "version": "v1", + "category": "Cluster" + }, + "ApisApi": { + "group": "Apis", + "version": "", + "category": "Other" + }, + "AppsApi": { + "group": "Apps", + "version": "", + "category": "Workloads" + }, + "AppsV1Api": { + "group": "Apps", + "version": "v1", + "category": "Workloads" + }, + "AuthenticationApi": { + "group": "Authentication", + "version": "", + "category": "Security" + }, + "AuthenticationV1Api": { + "group": "Authentication", + "version": "v1", + "category": "Security" + }, + "AuthorizationApi": { + "group": "Authorization", + "version": "", + "category": "Security" + }, + "AuthorizationV1Api": { + "group": "Authorization", + "version": "v1", + "category": "Security" + }, + "AutoscalingApi": { + "group": "Autoscaling", + "version": "", + "category": "Other" + }, + "AutoscalingV1Api": { + "group": "Autoscaling", + "version": "v1", + "category": "Other" + }, + "AutoscalingV2Api": { + "group": "Autoscaling", + "version": "v2", + "category": "Other" + }, + "BatchApi": { + "group": "Batch", + "version": "", + "category": "Workloads" + }, + "BatchV1Api": { + "group": "Batch", + "version": "v1", + "category": "Workloads" + }, + "CertificatesApi": { + "group": "Certificates", + "version": "", + "category": "Security" + }, + "CertificatesV1Api": { + "group": "Certificates", + "version": "v1", + "category": "Security" + }, + "CertificatesV1alpha1Api": { + "group": "Certificates", + "version": "v1alpha1", + "category": "Security" + }, + "CertificatesV1beta1Api": { + "group": "Certificates", + "version": "v1beta1", + "category": "Security" + }, + "CoordinationApi": { + "group": "Coordination", + "version": "", + "category": "Configuration & Storage" + }, + "CoordinationV1Api": { + "group": "Coordination", + "version": "v1", + "category": "Configuration & Storage" + }, + "CoordinationV1alpha2Api": { + "group": "Coordination", + "version": "v1alpha2", + "category": "Configuration & Storage" + }, + "CoordinationV1beta1Api": { + "group": "Coordination", + "version": "v1beta1", + "category": "Configuration & Storage" + }, + "CoreApi": { + "group": "Core", + "version": "v1", + "category": "Core Resources" + }, + "CoreV1Api": { + "group": "Core", + "version": "v1", + "category": "Core Resources" + }, + "CustomObjectsApi": { + "group": "CustomObjects", + "version": "v1", + "category": "Other" + }, + "DiscoveryApi": { + "group": "Discovery", + "version": "", + "category": "Networking" + }, + "DiscoveryV1Api": { + "group": "Discovery", + "version": "v1", + "category": "Networking" + }, + "EventsApi": { + "group": "Events", + "version": "", + "category": "Core Resources" + }, + "EventsV1Api": { + "group": "Events", + "version": "v1", + "category": "Core Resources" + }, + "FlowcontrolApiserverApi": { + "group": "FlowcontrolApiserver", + "version": "", + "category": "Other" + }, + "FlowcontrolApiserverV1Api": { + "group": "FlowcontrolApiserver", + "version": "v1", + "category": "Other" + }, + "InternalApiserverApi": { + "group": "InternalApiserver", + "version": "", + "category": "Other" + }, + "InternalApiserverV1alpha1Api": { + "group": "InternalApiserver", + "version": "v1alpha1", + "category": "Other" + }, + "LogsApi": { + "group": "Logs", + "version": "v1", + "category": "Other" + }, + "NetworkingApi": { + "group": "Networking", + "version": "", + "category": "Networking" + }, + "NetworkingV1Api": { + "group": "Networking", + "version": "v1", + "category": "Networking" + }, + "NetworkingV1beta1Api": { + "group": "Networking", + "version": "v1beta1", + "category": "Networking" + }, + "NodeApi": { + "group": "Node", + "version": "", + "category": "Core Resources" + }, + "NodeV1Api": { + "group": "Node", + "version": "v1", + "category": "Core Resources" + }, + "OpenidApi": { + "group": "Openid", + "version": "", + "category": "Other" + }, + "PolicyApi": { + "group": "Policy", + "version": "", + "category": "Configuration & Storage" + }, + "PolicyV1Api": { + "group": "Policy", + "version": "v1", + "category": "Configuration & Storage" + }, + "RbacAuthorizationApi": { + "group": "RbacAuthorization", + "version": "", + "category": "Security" + }, + "RbacAuthorizationV1Api": { + "group": "RbacAuthorization", + "version": "v1", + "category": "Security" + }, + "ResourceApi": { + "group": "Resource", + "version": "", + "category": "Other" + }, + "ResourceV1Api": { + "group": "Resource", + "version": "v1", + "category": "Other" + }, + "ResourceV1alpha3Api": { + "group": "Resource", + "version": "v1alpha3", + "category": "Other" + }, + "ResourceV1beta1Api": { + "group": "Resource", + "version": "v1beta1", + "category": "Other" + }, + "ResourceV1beta2Api": { + "group": "Resource", + "version": "v1beta2", + "category": "Other" + }, + "SchedulingApi": { + "group": "Scheduling", + "version": "", + "category": "Cluster" + }, + "SchedulingV1Api": { + "group": "Scheduling", + "version": "v1", + "category": "Cluster" + }, + "SchedulingV1alpha1Api": { + "group": "Scheduling", + "version": "v1alpha1", + "category": "Cluster" + }, + "StorageApi": { + "group": "Storage", + "version": "", + "category": "Configuration & Storage" + }, + "StorageV1Api": { + "group": "Storage", + "version": "v1", + "category": "Configuration & Storage" + }, + "StorageV1beta1Api": { + "group": "Storage", + "version": "v1beta1", + "category": "Configuration & Storage" + }, + "StoragemigrationApi": { + "group": "Storagemigration", + "version": "", + "category": "Configuration & Storage" + }, + "StoragemigrationV1beta1Api": { + "group": "Storagemigration", + "version": "v1beta1", + "category": "Configuration & Storage" + }, + "VersionApi": { + "group": "Version", + "version": "v1", + "category": "Other" + }, + "WellKnownApi": { + "group": "WellKnown", + "version": "", + "category": "Other" + } +} diff --git a/website/scripts/extract-api-groups.mjs b/website/scripts/extract-api-groups.mjs new file mode 100755 index 00000000000..3e0bbc48dc2 --- /dev/null +++ b/website/scripts/extract-api-groups.mjs @@ -0,0 +1,174 @@ +#!/usr/bin/env node + +import fs from 'fs'; +import path from 'path'; +import { fileURLToPath } from 'url'; + +const __dirname = path.dirname(fileURLToPath(import.meta.url)); + +// Define sidebar categories +const categories = { + 'Core Resources': ['Core', 'Node', 'Events'], + Workloads: ['Apps', 'Batch'], + Networking: ['Networking', 'Discovery'], + Security: ['Authentication', 'Authorization', 'RbacAuthorization', 'Certificates'], + 'Configuration & Storage': ['Storage', 'Coordination', 'Policy', 'Storagemigration'], + Cluster: ['Admissionregistration', 'Apiextensions', 'Apiregistration', 'Scheduling'], +}; + +// Reverse map: group name -> category +const groupToCategory = {}; +for (const [category, groups] of Object.entries(categories)) { + for (const group of groups) { + groupToCategory[group] = category; + } +} + +// Load swagger.json +const swaggerPath = path.join(__dirname, '../..', 'src/gen/swagger.json'); +let swagger; +try { + const content = fs.readFileSync(swaggerPath, 'utf-8'); + swagger = JSON.parse(content); +} catch (err) { + console.error(`Failed to read or parse ${swaggerPath}:`, err.message); + process.exit(1); +} + +if (!swagger.paths) { + console.error('swagger.json has no paths property'); + process.exit(1); +} + +// Extract unique API groups from paths +const groupVersionMap = new Map(); // "{group}/{version}" -> { group, version } + +for (const pathKey of Object.keys(swagger.paths)) { + // Match /api/v1/... or /apis/{group}/{version}/... + let match = pathKey.match(/^\/api\/([^/]+)(\/|$)/); + if (match) { + const version = match[1]; + const groupVersion = `core/${version}`; + if (!groupVersionMap.has(groupVersion)) { + groupVersionMap.set(groupVersion, { group: 'core', version, displayName: 'Core' }); + } + continue; + } + + match = pathKey.match(/^\/apis\/([^/]+)\/([^/]+)(\/|$)/); + if (match) { + const group = match[1]; + const version = match[2]; + const groupVersion = `${group}/${version}`; + if (!groupVersionMap.has(groupVersion)) { + groupVersionMap.set(groupVersion, { group, version }); + } + } +} + +// Build mapping from class name to group metadata +const apiGroupMap = {}; + +// List all doc files +const docsDir = path.join(__dirname, '../..', 'src/gen/docs'); +const docFiles = fs.readdirSync(docsDir).filter((f) => f.endsWith('.md')); + +for (const docFile of docFiles) { + const className = docFile.replace('.md', ''); + + // Special cases first - handle non-versioned base API classes + if (className === 'CoreApi') { + apiGroupMap[className] = { + group: 'Core', + version: 'v1', + category: groupToCategory['Core'] || 'Other', + }; + continue; + } + + if (className === 'ApisApi' || className === 'OpenidApi' || className === 'WellKnownApi') { + apiGroupMap[className] = { + group: className.slice(0, -3), // Remove trailing "Api" + version: '', + category: 'Other', + }; + continue; + } + + if ( + className === 'CustomObjectsApi' || + className === 'WatchApi' || + className === 'VersionApi' || + className === 'LogsApi' + ) { + apiGroupMap[className] = { + group: className.slice(0, -3), // Remove trailing "Api" + version: 'v1', + category: 'Other', + }; + continue; + } + + if ( + className === 'CustomObjectsApi' || + className === 'WatchApi' || + className === 'VersionApi' || + className === 'LogsApi' + ) { + apiGroupMap[className] = { + group: className.replace('Api', ''), + version: 'v1', + category: 'Other', + }; + continue; + } + + // Parse standard class names like "AppsV1Api", "AdmissionregistrationV1alpha1Api" + // Pattern: {GroupName}{VersionName}Api + let group = null; + let version = null; + + if (className.endsWith('Api')) { + const withoutApi = className.slice(0, -3); // Remove "Api" + + // Extract version from end: V1, V1alpha1, V2, V1beta1, etc. + const versionMatch = withoutApi.match(/(V\d+(?:alpha\d+|beta\d+)?)$/); + if (versionMatch) { + const versionStr = versionMatch[1]; + group = withoutApi.slice(0, -versionStr.length); + // Convert V1 -> v1, V1alpha1 -> v1alpha1, etc. + version = versionStr.toLowerCase(); + } else { + // No version suffix, it's a base API class + group = withoutApi; + version = ''; + } + + if (group) { + const category = groupToCategory[group] || 'Other'; + apiGroupMap[className] = { + group: group, + version: version, + category: category, + }; + } + } +} + +// Write output +const outputPath = path.join(__dirname, 'api-group-map.json'); +try { + fs.writeFileSync(outputPath, JSON.stringify(apiGroupMap, null, 2) + '\n'); + console.log(`✓ Generated ${outputPath} with ${Object.keys(apiGroupMap).length} entries`); +} catch (err) { + console.error(`Failed to write ${outputPath}:`, err.message); + process.exit(1); +} + +// Verify all doc files are in the map +const unmappedFiles = docFiles.filter((f) => !apiGroupMap[f.replace('.md', '')]); +if (unmappedFiles.length > 0) { + console.warn(`⚠ ${unmappedFiles.length} files not mapped: ${unmappedFiles.join(', ')}`); +} + +process.exit(0); diff --git a/website/sidebars.ts b/website/sidebars.ts new file mode 100644 index 00000000000..289713975cd --- /dev/null +++ b/website/sidebars.ts @@ -0,0 +1,33 @@ +import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; + +// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) + +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ +const sidebars: SidebarsConfig = { + // By default, Docusaurus generates a sidebar from the docs folder structure + tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + + // But you can create a sidebar manually + /* + tutorialSidebar: [ + 'intro', + 'hello', + { + type: 'category', + label: 'Tutorial', + items: ['tutorial-basics/create-a-document'], + }, + ], + */ +}; + +export default sidebars; diff --git a/website/src/components/HomepageFeatures/index.tsx b/website/src/components/HomepageFeatures/index.tsx new file mode 100644 index 00000000000..c2551fb9b80 --- /dev/null +++ b/website/src/components/HomepageFeatures/index.tsx @@ -0,0 +1,71 @@ +import type {ReactNode} from 'react'; +import clsx from 'clsx'; +import Heading from '@theme/Heading'; +import styles from './styles.module.css'; + +type FeatureItem = { + title: string; + Svg: React.ComponentType>; + description: ReactNode; +}; + +const FeatureList: FeatureItem[] = [ + { + title: 'Easy to Use', + Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, + description: ( + <> + Docusaurus was designed from the ground up to be easily installed and + used to get your website up and running quickly. + + ), + }, + { + title: 'Focus on What Matters', + Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, + description: ( + <> + Docusaurus lets you focus on your docs, and we'll do the chores. Go + ahead and move your docs into the docs directory. + + ), + }, + { + title: 'Powered by React', + Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, + description: ( + <> + Extend or customize your website layout by reusing React. Docusaurus can + be extended while reusing the same header and footer. + + ), + }, +]; + +function Feature({title, Svg, description}: FeatureItem) { + return ( +
+
+ +
+
+ {title} +

{description}

+
+
+ ); +} + +export default function HomepageFeatures(): ReactNode { + return ( +
+
+
+ {FeatureList.map((props, idx) => ( + + ))} +
+
+
+ ); +} diff --git a/website/src/components/HomepageFeatures/styles.module.css b/website/src/components/HomepageFeatures/styles.module.css new file mode 100644 index 00000000000..b248eb2e5de --- /dev/null +++ b/website/src/components/HomepageFeatures/styles.module.css @@ -0,0 +1,11 @@ +.features { + display: flex; + align-items: center; + padding: 2rem 0; + width: 100%; +} + +.featureSvg { + height: 200px; + width: 200px; +} diff --git a/website/src/css/custom.css b/website/src/css/custom.css new file mode 100644 index 00000000000..d6669421c45 --- /dev/null +++ b/website/src/css/custom.css @@ -0,0 +1,62 @@ +/** + * Any CSS included here will be global. The classic template + * bundles Infima by default. Infima is a CSS framework designed to + * work well for content-centric websites. + */ + +/* You can override the default Infima variables here. */ +:root { + --ifm-color-primary: #2e8555; + --ifm-color-primary-dark: #29784c; + --ifm-color-primary-darker: #277148; + --ifm-color-primary-darkest: #205d3b; + --ifm-color-primary-light: #33925d; + --ifm-color-primary-lighter: #359962; + --ifm-color-primary-lightest: #3cad6e; + --ifm-code-font-size: 95%; + --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); +} + +/* For readability concerns, you should choose a lighter palette in dark mode. */ +[data-theme='dark'] { + --ifm-color-primary: #25c2a0; + --ifm-color-primary-dark: #21af90; + --ifm-color-primary-darker: #1fa588; + --ifm-color-primary-darkest: #1a8870; + --ifm-color-primary-light: #29d5b0; + --ifm-color-primary-lighter: #32d8b4; + --ifm-color-primary-lightest: #4fddbf; + --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); +} + +/* GitHub icon styling */ +.navbar__item.github-icon { + padding: 0; +} + +.navbar__item.github-icon a { + display: flex; + align-items: center; + width: 24px; + height: 24px; +} + +.navbar__item.github-icon a::before { + content: ''; + display: block; + width: 100%; + height: 100%; + background-size: contain; + background-repeat: no-repeat; + background-position: center; +} + +/* Light mode GitHub icon */ +html:not([data-theme='dark']) .navbar__item.github-icon a::before { + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23000000' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M15 22v-4a4.8 4.8 0 0 0-1-3.5c2.6-.4 5.2-2 5.2-7 0-1.5-.5-2.9-1.3-4 .1-.4.6-2 .1-4s-1.2-1.2-2.6-1.2c-.9 0-1.7.5-2.4 1.3-.6.8-1.5 1.3-2.6 1.3s-2-.5-2.6-1.3c-.7-.8-1.5-1.3-2.4-1.3-1.4 0-2.5.2-2.6 1.2-.5 2 0 3.6.1 4-.8 1.1-1.3 2.5-1.3 4 0 5 2.6 6.6 5.2 7-.2.3-.4.7-.5 1.1-.4.1-1.7.5-2.6-.6-.5-.7-1.5-1-2.4-1-.1 0-.3 0-.4.1.4.6 1.1 1 2 1 .9 0 1.7.3 2.1.9 1 1.6 3.9 2.2 5.5 2v-4.6c0-1 .3-1.5 1-2'%3E%3C/svg%3E"); +} + +/* Dark mode GitHub icon */ +html[data-theme='dark'] .navbar__item.github-icon a::before { + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23ffffff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M15 22v-4a4.8 4.8 0 0 0-1-3.5c2.6-.4 5.2-2 5.2-7 0-1.5-.5-2.9-1.3-4 .1-.4.6-2 .1-4s-1.2-1.2-2.6-1.2c-.9 0-1.7.5-2.4 1.3-.6.8-1.5 1.3-2.6 1.3s-2-.5-2.6-1.3c-.7-.8-1.5-1.3-2.4-1.3-1.4 0-2.5.2-2.6 1.2-.5 2 0 3.6.1 4-.8 1.1-1.3 2.5-1.3 4 0 5 2.6 6.6 5.2 7-.2.3-.4.7-.5 1.1-.4.1-1.7.5-2.6-.6-.5-.7-1.5-1-2.4-1-.1 0-.3 0-.4.1.4.6 1.1 1 2 1 .9 0 1.7.3 2.1.9 1 1.6 3.9 2.2 5.5 2v-4.6c0-1 .3-1.5 1-2'%3E%3C/svg%3E"); +} diff --git a/website/src/pages/index.module.css b/website/src/pages/index.module.css new file mode 100644 index 00000000000..9f71a5da775 --- /dev/null +++ b/website/src/pages/index.module.css @@ -0,0 +1,23 @@ +/** + * CSS files with the .module.css suffix will be treated as CSS modules + * and scoped locally. + */ + +.heroBanner { + padding: 4rem 0; + text-align: center; + position: relative; + overflow: hidden; +} + +@media screen and (max-width: 996px) { + .heroBanner { + padding: 2rem; + } +} + +.buttons { + display: flex; + align-items: center; + justify-content: center; +} diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx new file mode 100644 index 00000000000..2e006d153b4 --- /dev/null +++ b/website/src/pages/index.tsx @@ -0,0 +1,44 @@ +import type {ReactNode} from 'react'; +import clsx from 'clsx'; +import Link from '@docusaurus/Link'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import Layout from '@theme/Layout'; +import HomepageFeatures from '@site/src/components/HomepageFeatures'; +import Heading from '@theme/Heading'; + +import styles from './index.module.css'; + +function HomepageHeader() { + const {siteConfig} = useDocusaurusContext(); + return ( +
+
+ + {siteConfig.title} + +

{siteConfig.tagline}

+
+ + Docusaurus Tutorial - 5min ⏱️ + +
+
+
+ ); +} + +export default function Home(): ReactNode { + const {siteConfig} = useDocusaurusContext(); + return ( + + +
+ +
+ + ); +} diff --git a/website/src/pages/markdown-page.md b/website/src/pages/markdown-page.md new file mode 100644 index 00000000000..9756c5b6685 --- /dev/null +++ b/website/src/pages/markdown-page.md @@ -0,0 +1,7 @@ +--- +title: Markdown page example +--- + +# Markdown page example + +You don't need React to write simple standalone pages. diff --git a/website/static/.nojekyll b/website/static/.nojekyll new file mode 100644 index 00000000000..e69de29bb2d diff --git a/website/static/img/docusaurus-social-card.jpg b/website/static/img/docusaurus-social-card.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ffcb448210e1a456cb3588ae8b396a597501f187 GIT binary patch literal 55746 zcmbq(by$^M)9+14OPA6h5)#tgAkrW$rF5rshja^@6p-$cZlt9Iq*J;!NH?5&>+^i? zd%l0pA7}Qy_I1b1tTi)h&HByS>tW_$1;CblCG!e^g989K@B=)|13|!}zl4PJ2n7Wh z1qB@q6%`E~2jemL!Fh^}hYfz85|I!R5RwovP?C~TGO*Io(y{V!aPUb>O6%!)!~Op% zc=!h3pup!KRwBSr0q{6*2sm&L-2e})oA3y5u+IKNa7f6Ak5CX$;b9M9ul{`jn)3(= z0TCG<li6i8=o)3kSrx^3DjJi7W8(8t_%PJ~8lVjC z2VTPD&_&_>060+qq1c&?u#iAbP9wbT2jg5_aX>LlOOXw|dQJ8p&2XYYDc|J+YUT?3|Fxm{f?d*1vFWPGwXt8P3T#_TQB*NSP3+0+ndOe%v- zTZotCfofsS06&ki{<`Cj8{s5jFZc&1dl<{IBW%#V_!JjOm6+#&aRi;8ODL(?0fENIOtiNXjMhdO24CeDB#rNcC*<=TwpueFfx=2=r z-lt`qW^;vEFji%7kO25#YkwjKyZ93WFbbY!Q6-@Jz!9kqj>xgp2VhEYyMJwMYyHZV zG;7!MV>54LS*F?==$6(Z9S zfrEy``J-iu6G?#+q=$58MlrE}+C~G-hEMn#CuNuuVV;8#FHuD_feqmtfw~Ran|V#C zy+f^&q>|d(X{ubCVWs3Ai;Fz>-kAk`yX{^Qj_xV#NEV8oxtfCsq3%uYN0U4+Kcu%j z?Rzr+fnu%QVSgx7Z8;iqDfklVK3tl(C|B5~_ywyQf&|IJgyoV|q( z<1`6^2G=2%pTX$m#~!Q-7f>sA;n6 zsy{fJ>o;yxpRCMtZFb#E)dl;n&K%g;H?#HaC_HvnHuqN*d+9vB7ZNpfqqTsk*(((>8<~)=+HX!*Ss3~|# zShAf@XL@`g)$G$rAA9cU; zk+0v$7Rl=PDs_rN&*@^DQ<3}LIqeDu_8cvBZoZQK#xaB*@qDhG^d_fYSBG@Y_wC5B zy{FTF=4jI`H0PRGXlulcwJ$*KBs^);$y@AfTWB!przp%+gn+%ZU2qD$Eml|2m?K;y zsAx49(J!Aq5lqX4u5Rlh{1hD6V?uI0-0}%=eSBZT$;aWCJrM*G=&(~P~7QxUJFlHF+63{SfFhWU%gt&D(4Z~X54CH?JsJEHzO9{;5# z5f-P_*$Y>=CXYL(i4Vw1)$Y&DwihU}jeLyuS2hQ>zS%^7!rET)y)?ZI;W^c(neZ5; zcYHr@l=i48ImXZ(y)o<7>Av^Nw!8t!KDn{67gef*G5f-&iZ;`G@ej`@uBTkn0_QVc zw|RGr%!y|LdrjWk$H6iyi9+o%)D%pY)DHt@e}~ z-ryeSdskl$jkA%Gje(z=CvGUb4lqb$@>K02q8; zBpGv48m)G3Jz8nD`*7z;ch+s~JId9q{~KmJV4qG#VyhtwGh1U7ZW~XgF&CHVcfjI@4|IAMzt7B{D4ttmRhW76WO-cP6HX>7cPSIon_Pic=YB^cwH;qqm2b=+@OjfH55;lLt@>%R&7MejNBW98rLJXZZQtF zmm<7wrV(U^X%O}rZp($;Nb;(nTO##-Fk_K%y2c4)Yt?EsKDLVz&SyIxmRvPYUf)~A zkMkfE4X%Dz8*f>*I$-5J)wLSdUUaV&xP%U!WXidR7*F!E3|fu1supvKyq>T*84`M& z=Dt)zp4h*&a^3bbAWSy|{$~mRt znU?J9X@W)z1+)2SKH;RDEk{C{F~PxzePOC4k2I22=OxAKZEhYTo#jZLnzJRvL-#I` z%_%U{YhbA5LxSuc7mb|<#t0l8BZHy-cvj?r(|M5YOMU0wJ}PLj6z+91PP@u~sUN(0 zoPkUiqj+}m^;#5WI-p1sl3!d`><`0$1U4*Tus{#@{oJ~C_^ll&fIY{RWHLB)Iw~-5 z_trhoc*;Xx|5u&|7Q=~%>SU9dJXt>XnSP z$}G4aR=bB#EC~i5U_z8$Olb|B1Ec2J6a`$P64P%*8UxnscnAmYxki;vGRSH!M<=El z7AwT}?l;S3Ju)fk9NDaW<~K*9J6DCaimLP@Zry38*StONeVaYg4GMSV1sb;$0#63E znXJh6$=|17p)3iget{zQI-ZcSA4kztpbVusXh9 z97)P(^GVx?9}T_w+?VG}Hu2dxs!PdI;c!Skm{8crbnUpgGsmO6Y~0f~`3af#=;}JO zs+>jl(}Ww@TF9nIIp*io9|Ar+SXKeoJ2p0xqq^dDIUaz_3UMRe!*?g>RKH02EKY^8E=Ov%mKqCKc_O8|58B$F z2nPy$8uP`nq5-GE>)_IseB*$*+;W_EcowmS_|Q%w=6aW(&AB z%OtxG-1&Xrq>E%{bjzK4kBw z>Fssz$u`@4(H4(yPd(wlj>oT~6v>IV?P zZDj-meBV3Xh&lOz7Q@p@Wg;VMtEtz0tWmBTlY%+n#pR{sF{)xA5u*BuDd zu~BvH^44yI-2poCTSulFIMHH|6$HIN2!U|l513rs>o5b7&T060H4stH!Rj6uhJ>*c z|EXULN z@Ms{ehhc57nJbz5tP(eS6gqwNx4;1P!wL~Xzd!0hhz^)}wUrh90P!E%NrcHnd5moayrW^mwAO&F9eVphr}#sl@u5#&@cZG3Pef_5ki2d4No`s`w>3E)~NzQq~(%!wQ~iX zS=!>QgW*;6d%-30eCYi-s{}L5+4xRvjRMVc-|_!cJZOOW|D`V>G$9BAul9zT%D`1W z9M}_f^IBfCT+$nV07$(ZMgM6Q>awY7HarX62K->7rWiZ>Plf%@Tc$X)SUE~YSzKHO zOo@t904vq~)2~8z9N~Y(5ghjQaweijSq9}$13ISo#S19Gyn+S8<}IqydMB*M2Fv(F;m*Z^NjCKA@hf(byh~F_Wz8Y|LB9G zj>CREj|u0+^+~|!q^Z4wYAm~DH8vU0K5hJLx;^WW) zn1WdmfwUxh0&F)Ge zJJ$CZ;Gif2pJe@g3jR{7X$9eG;iwp*gh^4;#?q$usU`sYWi;VGk9zUsuxLCqS?i4> zU*!nKB+RzHh&TF;OaYU1boXkFHseTZ9^7*ClUf6WeOAm2`Zgc?XVxs@; z3fyjS*rbEGB3x27NK$sQDLqTsoYX+=I47hKrjQhxw>;|F(o#M)1Zs3=vHf+{4*=lU zQU(~L2n)P!C zOzn-%j;-zdo*A78MJ(b}aNl*Pd%bH4<%$K3cP@a%?zXvnXr7tnRf8PyxM=h2%x6XV zGm+MfF#t#t=FVq6y^o&};nl4gZ1=OgS0W6oT4??aAn_EswVeD=G?0*F3Ky5X?YMg! z*>m;`U68Bw-j3*NS)Xv59AyM$#IrAaBLy!3%T~RztCkOyD`0Oh)~c45m`f(fWkn+8 zFDQ?ehB?iesKfXr>kR(d+^nK;|$bJ0BgK9l#= zSZkY0hNH`T%pTpu&S<)sN$BmKep32<*GjviX5<~dm2S)BRn}Za<=11?iR0CbzUy=Y zs!S!r=YBKN!Hvrz2HB~apVp)gQ@jZ_C@MZHwF>*RQt`RvqEl`)rFXy;*9O;aJ^+IS zAuxBFkwxDhrD+zs6}YE;!WWE7N;x=xxy(hv8tOrT%;~evWtP_;i-tw#{=|s|_1gD} z+$ZPC>;C15y?f=k!B)}XV?@W+W5Jl7E#au2n|eXFYo52!7iV_nr>%rHTLnmp5t__ zeQ~n3Y!)Mwq>pgU`A+DOtI(5{uM`!T&#y7{XqPhrZyx}q50{b`55VTpH9@&go43WC zqZc?IJ_ikEfm4 zqiap;*teY3XjF&M`E)w#v0j2fK8>&^=3ARl7X5?sL7($cGUyT(&GjZ}T7K}UWUq6o zgZIm=(`C|a=eg_1ZeQ8aAv^V`3$rbeo%f|J-#teM&do=aJ4+|bCGzXl53;$~hV*A0ZA5ycpm&br> z1s-woGI3ag*H2HL@1`7`+#zk!nQo^`L}FmXBF9_OVvslb3Qd{^lg7NlT6j-eh)ldq zIsckeM z_udDHz~0vrwpZ3KkTG;-vI!dRfSCp$d>Y)?cj8N5Tr%KDYlI~&_w+W~Esn4I>jEK8 zFVT=y$0H**Z{;PZsC?US7QBb(=tZKtCHDjvqV8L^j>>H?^4A4kTvR^*B7Ecb4?qFk z;I3A-%I#4)i|WCd)!jLZw1itTxsZ$F`MsNa(gzoB&z!Z262^le=~~4I&U`Eb`C+z^ z-VqlxQ;MGC=e90n>dE>aoHV5TkqviF0s?l+z${VoH%t8KFvbH=8^6e$^AlVGU~39o z`MtfitBvEM13&NqqE=`^fHwS_HEw#UDbHmBR+1A|sO+c44k$ zHR9{S!q-(m1a+=}nRGQkrWg-S#Cg;_7%!4Ry2VnE5r>E(^0Gl4^r-P`1z2qO@^9(pRjEp!;DAe7B)FZP$pa4?IWYcn*v>YZ(G2ETw zy|C4)s}8H`Ddud6ogaW9O%*z&O_X=V^6P+mS%uG2EcbTZmk$RT3*(0o4D%(Ts3kn3 zR^3eYF*}KjX-S8m()tqnj4;!Sp!Ho z(7&2M@h1HM;%Et+(u{~Toh0sg@7K`vuJ8O(-mWug9HRvjKP2RmGqWQF%DK(bM_*a0 z>f3#KhBt~#=bL&FWEC}JiXdh?Q9fn5e)7$+{?1Bdf8>;*vDW!BMGjU0?$JBadm(AQ zHAmi$WF|HJ@r5-F$f^VPE+X>suAfbT1DUvi%}6k2#y?ZFyltx!?p zAr?D|oG4gh_c+U9sb>u3LP&?IzmiCo$x4%SP!Q8Q(jEtG(-GPNIhRV_K5L z7Q77k6Jdl2*V9zOs=X@?=vUZ(27Ngc&%L;RjmxGl273=|7++0XC*K z9Zp<^Y~Pm)w3D*jwEo<^OkS4Y<#>lqUb=O)W%Fa5t!Yi<%z$TRIO#_Z7Q3QZ2H5BD@(x_63h;Y($5taTf_%0;ZvK_v)P3}%^YaRF4ri60UEoVB z9tvN{)Jtntfs9Z(yp!blwx06#5$P9W8ouO?r4Ila4@;@S!F4qL>h!`rvxwm8$-&c` zq^<(9nR=GK@B4e0qjX45ZoSs3?|jeZ@13@KMK0R)%1IlSsLp0DH)BFK20FoEM2kwW zSasI{O!BwCJ+a#u@A3ot$06uqU?n&`1G^@J*u|t@Fqwmwe+Wf0fpg%{_PCq6A2+)j z2hE=ehK9p~efCY}}Fj~mMr1Qr~qOdueZ6a_2SDwHZ*lG#r|D%`UFa~RYpuWgUN;*|PxsXBBeqTj`RJnU2 z9PE7zrU|}#_j#k%TQeT63k<&b?|z^RNGOSfltB4MjA|mxqLrdoZ?;jS1BSRxcR{3 z&%l5U(~v7ESy(7pNhyb$1x}p^+*ny$*~6KoZMdfentT6QH1Dr`Dd@U^^%MTqyRNen zJ1b!yKUiiizxRn-n~&g}YvqM*{G%USoM1&>P*AuSldPnqET|FpU!M=af1wNq_3z-J zu56ng_&fk$SpR2Tg&VxTY(oJPP3gAh>wSjZ5#J1#nHbkU`Cof;dA1dQz?$+;E7aQf zK?$L1IL6d(9>vPMi+iISD+SJz*W!e)X$i&Pwc(XN-;gZPke+O!zgm29u4?v!xUP9C zcK48Y@K`NN;M7x{1@te z=@S`oF&M(3^!G8wji3Z4u|IZUp?p~QVc?q&l}!U>SAWC+@B3Q=M8Gx8SMIb+e*r+q z{Yg@g$}_Sz-mgRV1*RA!0Rj$rc-W8!5u7m!h@?;r;RvN(6Nx9m1}wb6UV=69pH!1u4ND1C3^0#GV9Vk5v%jLF1iBkM+~_oe#(k6e04;|1 zqVxcTK}B~<8@cW$rb+NWw4LZ7KVGkN-UHS;bD^cK+2-3`Rj^V98<9f`kPTuKt;S`5 z?|)V)15P$Dy~TG^p+BRJpbTIN2fb57!5|jT#s_X^pnNi>exLT+xuR}kI zLTF>DrKH5As1d;xUMq}JD`rE#xm<3PV^bKt~*|K(@>_s$+l6?PG9c;I$Y$I9Wx zA;xF_MZf_#OaTl`qJ^-80rMXYZnX;yHMnC5N`v2j=zq5Pz&RPG92*Z}aj95Z+R(pq z5>Xr9FJ8qsGy#`dMOy$X4%|!w<&^&whNI5zri}lV6#?4!$Ljbv_f0<2-3Nu?974eOh|NodBrc6s{g264H^#+vv zkI(-F!??JN@B<(iW`KcV-0ngu+-@)j;0A>UFo`kAQKI6|7gl5B1rI>b2tj!?@U%?! zpFY4#g}oL@l|*Hrm#l)1qwa_0RO)Vc;oKlpABihvuq26}r$$LgB-%uwqRxuRrpyG- z63Ji#aENg52nfiiNRQwVk-^yt-aSGBkWsL4aPbK7DcQKVMb!z2h+ndEs=YI%qUPWc zQ>IZ-)zB2Te@6Q%>$!xa)SLHy;OQb1@YE3;2Jiq}T8Nyd)7_1XLd)Qqf~l-gf<mu~bv_xL2)jRuX@t1;#}dEe+$KYBs8Ozc8vKSmQMe zW+znS+=sB{$!eWdtEK&;U{CqQ65Mz$g8{KO3091K?+PmZnxe)Uj z+Qa!s1zBptH)^y=Y^r;+YwUV(!nv}S<^CwP->`OJJ9$f5gUG$;btdeT%D1lTQVA%c1zi!li^! zRC4P;e}Vde23*`#o$}dkJ+39wA!C@gdHJNz_ROozn%~qZ35{gxr zfiN+FJmv8BeiZfN4}PZY+~4(EHI@`4GB%VeN^dL-nxv{!>bS=G=d1&YuW4g(RYo?9 z1bQp@-L75k9jgsahz$6&S+Al>N$6|(Uspyh?G^CV(>yb-uEMv?{QHK7y|JZHbV$py z%-C#HQ^wHzF5_m4mG%K(t4T}wM0ZA{r9PYV^B7{;x3r!Xhwb>CR?<2{=4)iW>-lFp zYAZW-ff6Srzcmf>ey26kFp~2&CwAle919+v=b#GbfQ_k(^GDH^U5h6Ij_hJl+$cY7 z`$l|J9)NY0%G=H3-AiTp4`ibZCebLFOx0X*^9LW5S-jM98V1l7TC$z>H_cy3Z}AyT z7cVLl@}RT$dt1%R4$rYgTUqZJB_<@D5gGBnLzk|&Ap3rHOWJjl)n=4BT|4ZgqT{Y# zt8otJt6vZPNdUZ->2VQc|t#}@1f$zuiGu7Z`2Eq_iUO7kLfvf z3+3l;rJH=!P82eCED=AEqW3F^^w0nBW|fbIo$+A)nzK!N%82P?SXGa`4vSNK00<2u zG?U_{jq8ikbd8p@c-wd;R3TJ+v(c9o9< z15te~^)#o6%yp?zaR-=9=hVgU2)|jpPHt`JGmCnIB+qepbmFikm>#nfBmU{7vA8^z zhTK~#rjjnUOtV*azuR=2pq%=qDo}!HCW$#qTWyAliZ8Xa(cAZ0uV^tvuLjr-#E|<6 zgACc9`oD!F+lpA=rLNEf$nCx{x6Vg$hB|ia>mt1(@zkT4(zdKQrNiynVbyP`+<(GC zZSyg_F+eKZ$i9krPDP!?9!-GQV7-#k7*{YGhxdf%D@)yd=P%=c?r60bP2qytty%-G zh7;7A?%TTQIkk;cPgbW*m6aq{m1>`^R}`Bmi$Y$X?QaEJ3_Auk*q^L1i~N3dGM6CL zP<_JeZDBHK(^_7!@i}$(_U*t}@%hy|H{~Q{;gP|bU)fn%xGdctI%`>elX|Q^@vKaK z!d+`Jp@j=)v%^wXH{7|-__X;}-BP#uIY3=_0IGNc zu~4o%m8|B~5EtZ$^}=3sv!lGEYU+H?Y3%_wM6P8#*6#HJvT!3ul#<{n9ja- zRGu5okTwJ1Zmk}BqcGi4_;~IURanbdr+P5iXG<{exUhhs+*pLQ^{jA#EZ#>o0{+2Mh|5& za#ugek0I`(zQL#5eLDARVY*Xa(DwdUqkel}vhN3?;f0iO-H(xqufvN&!zQI78i>uE z8>&m)ewHaoGgtXPku_dEb6PORWr~;1cC<+G5K=KBl%`A&gp6C>lB)v5Ri$FsN;P4>0AbJz7kC<~Dg6Mg7fXVHmZhEHpA*eA&u za?3ON*{!W8PYLPoTR+cR&PxuH$lp`AWkTjWWz)Zkn3TIiCEofih+Lm=9GE(9)!Yfc zt(H1<`s=^*222e=?7hC0lh4e7B}PtVI_{cAdxGNtdfZX}Ca>Ti9YS^NB6cCtzFtR} zgaj!>#THZKLuuFqeb58ou+VPMIV94Az9}?pq(nm5%Nr@`CDh7dQqUo_(1Ka~Jk;oawETtB8>b`mRyBtgh zO#hV*Tx!lPBM`YD{&wUnqnt2DkRmgRC{h$?KYyR zNy|HI%;HhKQrs~er!LN>c2+qWT)k%E+~E5H9eFKV;EhkieNbfqMTavz)YO`;;q)r^ zRKcAY}gLEwaGA zNB*t;%C<*Y+tgCdcJX-=MUjGgyz~ESiO9#&b61{-h<+|2 zO;mjRZ}0|pCLmN$E}rD#(9h}~)QpVO*=OQA z#Y%e{>N&D?0uC{dY5L(<8J1$SoXTWsj~6x5e9=~^#nEWa^lWqnid)H7wg`B&H>nuf zicIgRBoFD2ii?SfJ43AUH&TVFO^DDYcT;;?zvOP%hwr9IDk(8n^Rrc$KG_W$S^CCU zJn=ZugG;lxxPrOnJdw}Typ5n~t5&$I{si5!MLacZa-r_WCh{j~l7-Op=$9TV5idhN zglm&=R)0UNEvq|kz+%&#x}Q{2@c3ZLBldp!yX7N~c^eZPht|o%1isQe*+RisbVF_% zc)4$!;>pF);4JrP4@@UX#!&8hI;B{0l7;+j>*r10Q|es&1NFKQ)-tV2$Om$A@O-## zCLqC6viD-87K8StG^Ws5ct0&olMkYox>$?+Dv3O{NlG}G;g5QSmf4?q;BsuQo`^U|{x}>ACKXRkdd^tU`U+|LS znWy0^S2)LcB@0!EdDt(Vij$36^78r3tM}C?KI}e^X9-D}*M!iFT%zNr0Gf&Ck7!`A>(uLE(OdeRwb4qX3EiMVz=vWC3?2PE%-wA%a1ap0C zl~rRJyzSkY8Ag$Lm-Lq^*t1^}+zs%@8si;z!Aaw5c$|~Vez}RpL6m1>KPeiGJ-kE2 zbc5&X&fJgVtRw*RtiMc#4#s3H)KgHzHqg{R3E#R(bk3b8<&|L5d#($dxdtH$sL)Ko zW+BbDfPQKTs#e36Joca~N!pf`_Le7~Lv03)(7sml@e{h^6)?B<b% z4<^3n;sOFVdZ|+>M(^LPJA^2T?>N`FCB!o7f5xo^osCpJG~aJR*pRaJ`|hF>b2{X( z4aKEJ#QV2I?XR1|0J3}|ZH&ySn!Nm=`P+m<#hI$;xz?{pkF56P+%fUR#QbB?5vU@D z`>PliKDIXEyl0$1ZZC5zk$jU4dGg+)S}VQJ{2eA&|CmIoN#1+}`@$?!Mu3F2+9T02 ze0p5ot83?2=!y%bJ6DW(u9o4&WO$pZ4(odr6?FoB7XL4e)f!oeU;7hCto!x9u^3y2 z_p)OlA3aa{6K=F7$1_8Kool5Rz84;b!W+-X$m#2JgTdGR`~%<5^BB{h$tmHspv zRGNoo-aTFhEpL1CiLM*gJ|XE30ntfqZ6RW8RmFz7r7ZSdo2F`+dbIqX^P95F?^XML zEd;Je?~!LW2b^bUTSOUq6$IdZfuOEh#~DDY>}8&v?k$U}JNqeWBw+k5RaOv)s}jE= zQ}Q=>D-=P$ONyT$s*Ds6LSFrpWZV z9vm@*jijy=tPX3=aU<`d%SuI}+t_(ucyRkiyAE)B^U$L7DbCd`ZfC1GSJ8C#vU2#vSFtvhw(~TDanF;rn!a zWgH2WF*ekmAnI0Qm{vS{Le0(+uM5o()7|2IRkMwT_#?fPo-fNKuG}%_?WB5XSGAlb zor5}ub|f^JD<-m8x~AHfvW<5`F`lhl67hM38YaG)q~vy{D&^Yntrm?>4z^ZOsgY#Q z1rH+LbV>KeLE_&Mx4guoLMo);;h{zA@6Vg{<*=;A?ow0;2nhIdN=lYmb%EU~F+?HH zLaoso&FKfglw9l+vgl0wD}L>5CraD=W3%oYoYELRdWj9p+A0?Z!6LgiDg#Eu>Ssf0 z&g1y!IZG_R=3hb@lHbRp(1j)&W)S7%^q<5B2`lgE5Sih9hn&%pLfAg~&g4O!dAzEw zr6}!RX6}Ey-TL;=D!pNqHJX2g5o#)RC9PgCs$st=+TNbHeB0ziMr46BDXhn3@+9lb zakzM5tAy8y(qP%tE{ZSGapnb4Z^LN!*_y7=s>e||+mVpl^pnes7OO}vC4KH*VY&(u zBMQ9fD2JG^z22EVkkJ~(SO;UACk7d9{ug7_|C8~{@mt)aT#ZU+DQOUbF#6axF}^Fd zmhtBwd{#Y3lNT?|FIsK&gZ~-#n-Y__6Paff`W5$GI_?&4)>Y6wNn%X>=Sz?np7Qyo zZH9g7Vq#S+Wke2_L1>5intVG>$_RV=;j_%`e4O#OwWIFnFw^vf``;Nw$R9Y&G7L@Q zEpjyn?t&uTR?$ToG6e_w*elUbNC~oP3@8{6T6R7*{BS$ppthlyGy84Q%jeFbF-1n> zO)SGM6LD+T;r0urWn8w~gEyVb*0_W98_BXWEHC7aW9+`WLmR`7N+r~9=L(~xq$Jgb zc0`M~DlkIF1Q$x214|&HJK67p$TCg(T6J$4SH->xR%+&~^((0Nxq2lp^|OY^7-4i; zBL#gyG5+ECIpe3%Ik#hK5FP>?%G+Pa7_Z}b`G(asWH1;##`0)}=0g~DiAQ%12Cj5i z28T%p_C$R@L_1|{@r`H-3@utWDI40LfR4i!SA32m0qYI@45{@x~z)w#KlJvgXw}%|m zRo=DGsu9QXI-g+Tl7VIjr}mX;4fZ(YL6iQz z`lznb+}yW8^|YL;n26~KwXN#Dv2^Jf8J;RGE5MC0?77MSdMq!OZES zr@rC*vXhutbr*g#pI;TJ7-h(_N3>Ax$cW*Hvendxf#T2KHpKfFv0s*GVYIHa#ER76 zH)fn1{!z7-v31;4FFC;np`(vIh~mi%Kk6K0qRrbY_10$&xciNpno*F#wFH=MCWkdaFgK=U$FHh6#XJ6e393;9h_D1Zj72KeX!pg_>9E<8*a-g z^}Kf2k*_7=T(WO~W~`LQ`#b^ur_5KjDOs!UUZE)a4ErIxiW)A?ryWE_hQ{K-z66() zy-hd_Wf6g>qeoGlrK;PChpG^jPZRHd1~2MDVv*}eCafA~rLyFEm7f|EuG-#T2SgA< zQulXvo;0LIo^229Q9ItQ+RBrWH?~QpcDh9k(_=n;aXhtJh!9kR$kCNj9kJ=~BEU51 ziIB~(jdq=S3*TzWE4mQ!!I|ecuJydbjIPp*Xw5Ghu@wSqzc$S6Ix+3baF**T>Mt41 zK!k+2I%~h$4?s4Ot~MGVS3+Ob?$pC%AG>el2v|PfPf#)JsHx(Ctgl_0O>zUrPSn=nDj;t;8OUo=NMf=eZW`H&)xh@0RbL zug`wD9%>dDMf!g1Mmbzz7-EO^Yys;ref6{S7=chPEbgzvK3Ygwd;HLVo?}5(#ACVb zWsLd8mLOML?j@oEu`Ybe-Ndygs{ANWu zTYi}_YQ<948Jzmju!q^KwWli0(I_g&4zh3T`JS8oyS-JxRIlxlOkv13y^u$ebFvDyZKo49C5A{;Tr}MGMfceW3vqv{k;$^5ymBa8D>MecFsutjT zA|2ncpoEfZ3}EUt@Ng34X@75@l=LMd z^xZ7gESH4|2|k980z_jCp=#YZA)wxX8X~1diHoFqFvh?^Q;)oZcQ^W-l}yf5-ITM^aKZ zdfcjKlYl-&+8kEemP6lOR$P)7OO`b%yP(T25cq|hroP0p;{1@NydW2?&Uu!(^E(fD z#^%)iOUjTB^}P|c>sOo(_ivgq!yorSoV_H}q{tDvSL(K+bRbh52yrU?;o;#a1$BI; zG0RiGi1qO#MDdZ{{&bK@3)dmD(0ps&@XAgmQ$@l-h4Gx@t|NQC$u0q^d(ku>t~*n- zd~721PFdAKA^EX@ux5Tar!^~Q?kN4Q#)8B>%mcd&9luSEH|o>s^4tryTublkdEEI{ zKR#&=Y~)FcH*t4`M?g&TY~~}M>#}&vt3FYW)XMt2n{6+LCM@Vc2}fP)OONUg_(3`R zRab{`pOc0H4Vwb&4_9$Hs=7gmE~%pp$%I+QRt~Z=N*)eeji{_PhDB=gEL1PPqQmXj ziAC29F0k*5&JI!cBe@oy3-j>BSk^9W)qi|x9siuq!?B_AiaL9Ia3GgP?P`@aa0sC%Vx~ z4_H;|sIZ_baSi_@V?ArUq-+ig)fyk1eXqmTJP^R3h2&8I=PKcQB=1Si$Yi>2^`ec` zWhT-zHa%mNK+fB?4Hfg(dl$9ssVh57orM0LPj=M|2|5Z33$ZS1MD#ToTy?*a5E<)o zZ^vgVRHt{{s?S|cu9e|pBs<_KW^^?c+z zVk*-fa)Av4H$i8mAsYz;V>N#~@y4qSwKG%ox#ZW_-xaK$Fo)u_7H+~xDQI%!Bh|re zEIa^~TT?%8*jT^u!yxl1>%qYTu)I_Iwf#Cm!)=kQd!PDS6W_)FgT0q+ohn_P|7b-8%kc;m zg1^9mPpG^{HSkKoxNcleZ|3O*V?9Y(hvnWYam7N)*3PotcW%Kd$xrtzn4cx+@DGp{ zFPwjuW6B=Zy)W%}`8}SIrnZJ4SEixC`5nMMSLxD`jCML$)Oa|F+)t9}6J=&fRyZ_^ z*(>evV$1-$K&$Aa2X9j!@6ZDeqAYa1l-8b9FTg}aF(uUeG0nO9eI}>KD(22{Y3iez z8sj(PllCVvngk!res$*`DI4Nz8|c28;b3g=9C+P-zJQd-I3R2Rjn*zpn2l7K`Dk-4 zq4GHFR>DRKlZC)XE(X!Rv+KEpkgX@Ph)0`3j~T?RfLQbFSRt^V`+L0ShrurdA)6#R zbvLEIWqYfi#>&qP=f_x+*)14zkd8ci08%!rf(xnWtQ7*>#*Q3lqkb5ZF8F>;{gl*e(oha^!C7JqB6_d~123dt*fdvJq(?6p*0LOR6U zl~o@(cjQPyT3~|OL^gOFW$f2uVn7?jn#?#D74*G0zSOzzEpH3+v@4X!>%a#ZdTNAo z02SDS+U^x)AN~i#!qbx+7~#+diA%C-494h3`5HW7V|SpXT!d-y6K;E6??0eZ_5aM0iGa7jgD1?z-2)tt(?%)HrV0P2IbUwxg)d%!3 z4(Qq8t4L!w^x)eVTb&7NdkTc^eWb9hI4uNo=4Vx(!X0`ZmUUTkqhL%zXoLtLh)Z5V zt{c8kL1$SYHBbFM)7D;w($|K!o|>Tg+asAc(_eT~?!65~_r`GLc;t~??0R+=C$8+% zSU9dXJbLgR#?h~h;~9v{d|1ty%Q<2)Xi_iT>Z%Bt?C^@A1-{?xP6+qny4pNWax8sr zh$_z;Rh0)xfA?_O?hY?gv-D6ddJNR4@Y&jc|MeC)wpLV5P2%7;{EV$#ZcqAzo!qmx z?ntfHdsSvdZRqSGv5P*ec0FDX*}Bmbt}B=gb58YCcP~YrMboq0D&KRi(a*1$I=D`) z(2;{aX$+9#~ce9s7Dc;AlEy)1ge>u4P`ls#tV!AH}{Mrf3Ev0g>k_on;O1VUFJ zja5^PD~MNp_xa--s%kd#tw&d-JDVyx?UVu)d+29O8LvL)y+8u|%P4{5!jguGKBVVX zp!?(Q-W+--0V4ud;Ga3@%BC&Ar4xVyW%TLQs?ySqbxoXLB9 zegDO|`1jpj(`&Du>guZMs^_U@SzO2wiCx{s6}xlc&#oh~?+TXf7P=r0OSNAfr7?9= z+=L&!eF>@TAe>!T(a=TM0@E)Zl#UnR35M&^|&$%M!ToyO7X*>OO8DdjGdIhHXPX z?svWHw5|YD^yy!Ed6saf6-1ZQANVTlA1J0y8BhWitD!fgc0O*ZogU?W{Bt5=|3G*4 z0jq4((3_~e7hRJuRM`){U|z**Fm`udnq^RoEE9-!$k5NS%TzM(uPX~_hfO9JTpe|K z%R@gT`}pR!(lNGD0G4yAhj zMEi$N{5aLE!7mDWy`(!%x!PN3{hv3%S)|U`OK02zn;mkigLW|8Cqk||nYC#RM3piP z1hL@Q<|b|GXjZHE1wYf7mwb8HTsHNp&aOo8IRTPw{J4rdTvT7LGO=6`h|uC8t^tE^ z2nXn^x%`~8UdLhe>F%x^KudaWuj^CIgH|`GNqTS1huhCeAzR|zcVN*+D^GZvg@t6{ zt%Jlv;t+k^cO{`*Oyu4vy&A6z3MJqkIX9c1AKljGEZooh3;N(+_BT<651L-I+e8z) zJj{Ug6s~`2z968B!3)qy`JqVw0XcMz?Z)C-ni;Puf&MR5s_EUj`9^N zc;)D0ekKK2F19`-g_u62@O@lqzi$?uQmFd1QaNobI;MW=A>yG|U2xA+(&{n4;JspG zJ-vAO_MWK+!A_SoceK(e*pjJyX<)UFz?T`Y9-H}d$jADsFSt4t`-_TXMgbZ8=s-uI zN}uEaz=#(l8|*5;4k$FC@p&!SWuo}TbavOrfL;Xic}AxxdwTfr^OtTM9$#(&gBgL1 zCgRm~-OP9kaZ(%GS-8HpsZuFAHf+g8Ui_asA_>2N z{}WoY+y{;)wte$I9;{JE2LYtY*L*^DeR{mjQxi_YwYJXSbXjlVYbWV!4!n?iElyk& zy^M>mx?ICf@W0anrFqwS(ZZjxm2p{Ct18%;%=`5whuQRB?n4Dp#-@jXfH)`T4>T}@ z(>zL!clT~7L2ehKJ&TDg2W)5kvy+LcyuryarP5q}=lE*g1$Wvc=HHClGs`X=cHYVQ zV}5aV#pFaKx{*62j~+E^{o=!<`%)BcQ1;0AmTT>}S>h0q=-1Jorgo9}7wS1Vyu?Kz`8EX1p_-4{J;lNJ2x?N3deQ?__Q4X`u)~;kVttI`SSwqY})U zf!AS6{dh$TKArl?Vs+3KubJMLAtooil(z? zH&-|YJnm*^mH@3dxDfSU*-TRgaxN1LCP6qu6!CF@J3Oh0=h9*XU1M@+6Ladmu>#JL zivIKXm3}!-e;8OYA`>woR4Cl#xB3fxB-`Hfqdc^pNib+J^$P$`DP<2hsrEp}I zQ_(``<1Ijf%natpKc5HM-Rbhu=J%eJL$8^zKwH{4agt`@cU1m zpuThV^OMMoOu|w6wC==YEgygQfoIad0O`QgblvY9_mqR|jApUcdy(Lkr*{YU$F~Ua zvVw5Wf>5GNfOcC6tG6U_>qy0qoKn(JYXY~@{Ms4=6*zcF8aRn@6ME~GsrJ;*92N6^ zY&>yh34%;EV*Zw;eUAUiZ&wupmR#g{_0^$e6Jn*c<*U&c;U$E65sQ5)%m&SUYzMv% zL@{=a8s{6R;#~Aq!_0ZP+Tc)HXZ5ttQ41tW7Sc)-6RcWb|JVmk8IeRFVEm!eAw1hE z38h>Y8j7T!0u5>#PY-3{)X9)G95$Wv?EN>(`ptIATg601g<1x!fptG-rH!E8_D@^y z1dNbQ@fN$x9!1XHW+PoaRWA7IS^)5E@W13I|A?-6U)7!w%dBI^uO*pI%56K)#`Thv z-ykObUb-b&0wAUMakr6}NE zsL^B24*0tdMdL@1LP5fH`2~=$lzpVC69|=}~RgpfhWupn~ZWk?Y`?*YnkT_6$PAm99BukW^KI)qfJ>l z7gXMiPUofoC9Bro+CW7mC0xY!TbAfh0b1`nTbEap3tQFSf^P~N%gc}L-aK4q7FyV7 z-@5mo0)~jBS5zmee1R-;UOJh> z6|SRB=#IA`W&$$?_C^Vd&&Iv7(>d?yU;US>%S-BE#sGTl9D^{`XhF(sl)+s)nO|&? ze4$V+tST@VS}vAD#eC`K%Zkygf8sG>Pkk)Z^}zOVizMU#CQ8@4t$~e;W)dyD-enef^M{H?8TfvnQ52E(dj(=QWa6&O0Hv@R6& zpj@3*{UYB9a;QNv9v$&h2&FMY3{H@X_2m2D0qm|zED*}8veH-axyoutqwF+`s)m|j zar8t1hZeL@p<%kzlZ}vgS;u%!PwYlakwmV{6rHdH6q~lQx|_r;Y%Ugs)4647*q_6- zwwzIk*Nalst^J^^%Bw8uzG*yzsz3`;;iL@i*opd5c?gEWnV1H?)A63{rHAr_EeJa! zvLVTlcpd~f@!0}a1uC}NP)0oLH_psD)Bjj%z?;CVe~Ob-vUkv+@w|UkHrAF6MB^bW zXERG#+UDPn6}LdfiHN*L4Y63-QVWLf!d<@>3DgG5QHbSQ0JwNPO~03wt&=#W40a`s znR6ty-#LlsAr&j8WQN5p%Z(NJ26hwHL~*DZ#|M_0tKqlLJC0TPJ6p-04~_mvsh2yJ zcF|vIuCXa-`NLj43JP}KqP;}qDCMonly(h@e*0Mh66D5NoA6m#T_!NLI=5w|`!(Ki0SOZ$ zAkviwBa7y?yDKq$8j(Iryu&3z*5dMo_^O$^eVtYvG5y>wBjjSkU=jo>qer@qPsa{4_M z(Xibqwva-z)kVxKEJq4Xr}L8~Cea8ByVGjJxFPv1my_RMIXt})#m?ixGH;vQLnGs& z(%FW1e$SO?YtGfHiyh}F)3FgT*q%X`S4URO%=#xn@3tOVYJ8{~sR?|^irvM{_V*at zT}D$9Hho10>?JS#r@W#HExX0O;Wi%j-mV4;`RymI_fb#wWcsYLnJnWd4+R zQTCq409!kbtSIN$TtcWjf>tL_i%h(cneO6VujA%+V$YUuQNPitngyJsBYmT?m*Ew)fQL(Vb{TWhqd;;-aCMu8Jqy zw2Yd4`Iz-T{h?>b=3Q-OxR>m>!p8lX-+x@r`JYI8mIyx0sOg>cvh<4&)gh4hba2An zmR(mU>;-6VwQc7Xa@K?Gzs5RDL)+B7sH@|A+w)j!YwDZLn}&KJI*N59c#fg7>AE=i zINsqY>+;Z6qnqY*iv1VLEcom0AhDH{^4ovv?*(W=TKE((gi)J1#w**@D^sPqAJ0Z^ z$j~1H?&D{nlhjt!m+STEj0Qt@%!(D8{b_$=V*B5$ zHD`O^3SIt%ifHf~oz})(b3JpS2zs40H@I9~Uii*uhH}v@Y~*(dvxFpw zA+1~<>mw=oBLbi^HIV`mbpE*1zc|AKIGkV{vP6dakoiot8>A z4!wuo%14@qFmIw*7bgnXj!kmRyL%p#H&@EfeAD#S@6H6OJ&LhiV{HA!) zQ8Y`L$Bq9Tg)GEP$gy?S^oPqB1^qt zJMHL~Uk18aQ&>09jAbl$r2d*J!NI)XdVmo{RWDpYz_TPN^D#*p!zvS2^PUf-Z`G5nB9L zSnclzT+*fn7R5oMKo14@r@pE`I ze3}FQ5~U+Xv;woLD?&R1@SMdKn`3N0%}d>SwkoGzP}bmzboU+(ZNONteR?hP#JA9zYRE}5ryhmi9r+hJ}$VsJ66eF~hT_rk;{+D>g#GN`L(iD)H$%URv4H-v_z zS8NRLobH1LD(Vn>O8?W?juDIdbm`_;YC+B)1Uot(VJV@yVyEpYT*ztMXMPbjVW8}s zm5yBhVX3%jNNmB6FX15?X~x&$8R~&CKro?`7e;CJVecI@#=9J?J&k1Q^zj%F84qTP zbPUJI4atIQxEPyO2mpT|-1O;d9>CnVUAH11ws;v8$ccDV}ac2<q3&_&!wTy->U&lk5cVKJxb9R0Iig(AXDxJKGq4N#1xnY{BZl`vUHL;ndgi>@XYSTCgUxaNIFXF0C@0)X7TNicC_GjvQ ztr@xX9n#fJzpT7HS-e#ry?SurQZh;zH%PMWs>_Q+ei|7D16dA89Ot^8%zgP*V-v;V z=UU|U2G|-D8cN~^u(ut)Rh_yuZ}zoAT;cspnTQ{#fT*Eg*#53NQJgvbq0%VMGSDbB zpb12ox#9fUH9M8l()~6kFyoVTD4>7o((h*{n^hL83_%gyHLpBs2$HvORIcz zeCP>s?ytt!8_cs@Kg(fmNgZDKmHV0dwaV7N6|UkBG!>1)20n)#j(JYa%t$>0zji+} za(I*i?l~5PWHk;{KLKT^rnEG~8l^h^YHg=X0+8S;iFhD;M&s5W?zLD*NAI+~f6yf} zKsOhU;09vj)lK8lKuBOASqSsTD7D-#En9kwA@-+-bRERwB3TUftK_4_Gm?`W+rJ!c z8V*JIk;*wSu&`-(aKZz7DE<=O?H%1}`%`rBr zj`aar@#AMRq6?B}^4GFhz(Rlf(G}q@E_-E(N2^4H4!m)stH`W-#k?bK%{74=H4{x? zB6Sf18yibRl+kUyIyX#xSlTo!%M^xGb_^_!6y?X^k$#TFQI(WqH{T2PZMF2=p?MaK z2f!Y}ERcH7vn^|tZDLR;0H-Q^tbyZ?G?7UlIkYr6KLrPnMT&w8A=at-$*^CUQv$la zp*9NVcNaT)Z4*HU@}|f)v~;r1TiNK{CzI(r&Ce|YW^v0?QWB=GA|{?GZx%-c9-R17 zFIQ(Ho+B8)3+Qc6%zd&1h6YkP-6YVeQyuPFU$C)p3rLVssmFk34c79jC=rG=fH_L} z^Y#K1?Mb0x)=!J||1f;^50rWdxXAD`3LnH{VPjo8ZIU;CtkU)`gRuK(SmaFPNsB?h0arwM+5SUmvL&Q%t z85E>Z5&~)b2YQ3}A8^Anl4O#Q@7JY9uv|(8MfPz@rOe0;uCAy?;gwAQjVi0yGES_p z?h;`bIU-*q3wf!=5{2HAS(DdEVOAT5ktuKFsN8)J)Y{zvD( zr(Est_{Q#>jx-F`7Sx_j`{92xv^}bPxiykDTFQ7~dhc4A)ww_DiR`WAxzl>{`o9N( z23n=16>qh~Uek0wAtr-93J#q}{)OT_uu%z*yL|am1DU7rKoo%Cg8&XS^;dh8k40{m zE=(7&Eip3z6LBvq!&2ENm480+ewx!>8(vQr6mXVD_?ehccU1DFeJ7Q2ad{f(;^Fkv z_~G?yb;CeO%B=tU3D!-NNs+Yg+aH!2&dZYQMC~r|yH+W)S$rG*8rtKGb#O3CEpl^1 zSh5~E6-$!GS;vmz1S#jKVxJn_e|1i^#X3hK|2)_+Kg3m46!vITR(~Ad3(8S4wzuY( zA;t(*RNzdUbA{*q60*myOKCfZ zSSAEwT-~zu*X>h2S~ZU{TrIutUC)Y4){tO$t$tCTRF~NRP*E=~Y~GJ|U90UU14#;S zGlsxY?~zzZ-Q~ECZxsCiarmZ3iQd5$o&UJZ{ze1gP*l`P|}5>3^b#oXr3*IAUlL2je^D^~`l@z_vZ0u{S%M$&)aS*Ij! z-hNtY`2m7T{0c%9|7%sFe=RsVD`#s|FqQD7t3d;di(Lj|YHU}Qc*d$<$J=VPXT>6B z3OU;=WJVhDIq*|VAFqnsn}13D!LHm&D&u8PG(5yyF{(^`e(D=p=Oq90U*n3qEJ&2G zpti}lu$a4dBmQsh1T1Hdtcc{D~%)d5FjW%D3q_w1^wDc{5;~1iM3c$bb ziJQs-Loo06jkNuWrh>(DsmpA1L12D+XMxS{ERq)f@ZtAINzybplW5i2;}=KW_=G3* z#>w(6BIiecp~@#>B+daN?Ao??)o#UGYVLxg&$*(b>wsS7=$Wd=@Z7&p@^8}U3e}2I z&g_oikS81WguVK^CTR-3(7l#(1>}LSVCd>55Y_z~W@bYElp0Mq%K~P51c>4+RYI}# zpHXYgig7oHso2kqR5CT>4Vog>TkDZ1;`D_O$+AiB30ftzWGbmUT>wr5G@@Rc3$vp% zwdPLsKfcn3JmVIMPKP(X+q4WaR%_kR*l_QkFEq(l06CN)lu03-g|Ut+8I`MPPiltK zUwhM@^z=`bUARfFT!x4ff^N_3hREaZ#Iedfq2eVISz$jaT$2!k3k*Sw^Pq(Ou-M_EdYrJSmwf?&JJNH!_h z-&nn%za86-q5g$ZFcdR-`E&#G7iw-Pp71@j%fI)|O_)H9>d{R@v1Bk4E3&^lL&z65 z`3F^p>MQ_bmEhhsR+N8LEp|bjUJVh#-Cctu^UNw-{z9>z=PvyT{0n6dp>%6tLBT-7 zKyHLUMngn^hlhsrkbr@O!iK}b!KDO>Nd?+E=P?XvLpD4QvuD;_jeuoU_ zdTp8HsN%CkkDWX31pK(5KTPPoK)qkZ`gd|CNDHIW1XVYb9qXU(_}v9vU!H=*47UB$ z*$cZhOzSf#glqL0HAK2;FZCmX%5-pt!mg?>kr_5M^hu1!>8{L`ol;qZV_Sc_sY|nNi*)U(D*Xv7rj{`V!YA62maFW)Vpu|rqFC}$p5&0|Kpp+-+8Wlgw7 zAQZzc&Ci8mdQQset|dG**wvXDu|ml7hKXO9efs42=9dusiH~G#^M#Gy=eC?4R@ov1 zJ4fKK+_7vJ^)Y9!;xZ1Q*AJQ^e%i3HQ>76`>C+u*zSGf7?4W9w6AiS z{*B=>e%(MRyo{x>>`#_6pxkvxuG8H92y^(dkWbd2AiqI5D9!~#X1t&74A4Q;@x!ag zp(~3(KLdM(*s1MVeb+jg%F1G^u=x|=$zPwK)g zuZVuc^RjBB{duk~!{6{nx4v0l@&8dulgc(YTL!P)2I^c*(#Sy)T}E_xO={>vLE9fo zDS4r6X);W{Vubd45iK6*n)ezQ{>a`P{wico?6@lm<1yl1o3|Ird6>Eiwa>$xDl8fA zjFw0y=?Jh2N4W_EjGemBg!I%smb8Z&vox@8d5*|s339AStKf9EMUadr{cmY}9+3(N zB&YiZ2dLxFALeEIWAE3eLmUBq0k!jVfbnGdUU*0dtk+NxCF>hZYhmMrhX35)&ki5< zRKD=;(}eFDD6zICwOjjo4(3+Z*o*>q=Yy{~=hZp+cPw}Xfbu`v?hL+OCj}}k3%CN^ za&G0;z4*D?xv86kMhJE3+F1A(Y@h56I#S7q>L}JoPw^k#(hfA^eKQp)8ctVr;tQX5n(wuC4>kK@S(aHHUirpOekHpjGJxdjR!jmLzfy*fo- z{YS#~|0H|~_wJGwD7lOeKu`C~?!x~wqfY|UO?@^=h36)OWMaxhtSi22FgnLc9Q@^A zd@C#cd(B!UK~Dqc&Nzx^p`@+1GFUDZtKdv-1(Cld;55%WQWuXVQu81wyEm8a`^$|r z?Ipi{w-@&=Mfk^jBH$!fn64N-@Z8Lik7PGy(9K+WT7BmMe-ehgUTh67LNl(+e8(86 z28`2V&HTG8o{C|uf(1dE(9#qNHaR2FS*?|Wr1p4xkn)3``BsuUh5?#^Ro5J!p)xv~ z64E&ugeoFvk8wDxv0+UE(YQFf|DkZ13t0&&sP%UT?*fV;+c`sJtj(WV4rR7S*OR!} ze4;W@_5(1%`E^C|MShYGaWHW$zgFPjV?ys|zw^u)|mp zzZW@8AK3(#)WH~G<;aq4UyCnJPZjD`|KPIx3zcGfApP~X&2xa+8MM(ojn(Popz(Qh z7LG&zWPViDV}{J>c)!JXK3RV9G|@|#S6)(M^44FdY@Zo?KI^^N>16@>h=gV5YxNKC zt%4U8djc{e>f-tJ=JpK#?4uW9#L)@1iZN!!>c`KH41fNk0y}{qA^&mO_5+Xn-sN;{16^U3|i^_$7(e>3CjR*S7Qh z-mmCR%`tAs|zS#Rkr16}7&uyK*XNwU$%GAwx$C8-|d_cgGnyx0WU(pT3CT!&mTp zWBoGJqLPYmBJ>c^8d`?a<_E??^-Ti@hT)~TYLICauV8jGC#<8)4ii}I{b#p$82XoN z%5mXx5|{dBy}@jMw$WV230l~>3h42FD;|c-XS_dbGEtfX$+wxY21XHsb5V68*q&geyI&{ zy*^xJUJ9U{Q$06$n$w_}=ecFqIxIwAw2+E_F(m=sH< zPMV=Un^53GazGVHYZQPz>+7va$>6C6!_XiuUQee(~nJ_cz!L9acq+1SWfk&Z+1iAR*D_6J*f1! zQPQ7tK(uHUane||)U8SSB$Dfl2s{4q4Hd=-x1B;G@JI4@f-V%60@uF_Q2$0>Qimm zs5YcBp${DH<$NXM=zy(r?kI7@oD~dpszm+>%BXCTSm$U3u4j)`1j1Ua9P_ms^?zzAxdspPHo>g%$ZYb`dF-ZNrrx^6Mt4KiV>?b0pL)nYE~_ zP$NYeGJGE%|B*; z360 z=oF>sY+arM$80X*tGzsw7EB*>n+4SniQp>A$lxp75~+-xSL~p^JiDx2V-V3xY@;$O z%NdIb#SY#8v#?`ld6Tg{OmAq?i@GwZP~S=LWiP-DO2 zfPQfik0+e)UhF2jS_}+b2F1xi5y*zbJ#vULGVD8G8!5#cpJ{*>FEGjEQ~`dQ zcOU0y^v1QfPn5adbKorrTEV`n1jZ+_CsbJ?7Kr{!{MaVr<5I+;lH8( zlWWm?@-3xS25%g{URt*s)5O45P+KHTQmBiS5l41G*l2XM69dicDjS8R&7MI?rhX$| z9OeEVX^1FAvg=?cGlm5GH&pt&yd*=Av8$S^(AY%ltYRug)@W2>D^WA(SW;|dj#Bb* zPY9}ZL!MjVzPnal92|C{3IUIgvC$FM07?EV&8XVOsA2{>=keTXV!WOswB5r0g)(sH`pxVp$E*LSx0bY$^ho1gZ(Ce+BX zgV-v@;O*LCgouh%LTJjh>6fNe1i)!k?_(K>@#hAJi=BY zGE;k|p=-ghx5_WRZ|zIf2wi`nNO=!AA^h@IFVd>=cc9tAO;Z$>jb7>?tb6ny`W{KE z@4c#}i7OkeEN~Kt%gx{BlP5$=yT6^}6F42x4XRhqN%6t?;^?rmV5dyeoKLqcsOHK2 zbb#$ru$;PP7F>-8@AY=H`&w$0QopRgaXn7;V8}$bm*lMCBkc85YEVhMoV!yFW|9fq zOOmzYH%4z?uXN91iF#K}mflTpD~cK^sdvEd|BV->>NLNJv8A%AlG31C6zsX}U(Y-$ zZwF~!_}FM_&U^rCK^~wXBnkagUjoVFg9|^`O?Sx!Zea>pf;c8<%({Q|nH^JacOn1z zeADz)ALFn#kY)z$^0QBF!@D0pPDEp@pW1(>)BE4M#(XVf)^jdx86Y`CCpVU>tB zuWv)APNSav7T`?DGY-4Nv|7{Snoz5!!&0eVGg@vN53J3Ee_3g#hG{28yjf!D{fT1E zpg%UfmE;4?O=&gw@ZDbf3Hai_OYc~H3~3&%p!09Y^Dod7$$qC>#(szjxJE8nhoW^b zyHTy4i$#2Ft$oO_M0HjPEsBbN7v4b>>76ZMU^64jzyQgDIvRU(8vw zWPJAM{3hPn^}8Sq7x3jCh>#A0#0LkcK;;6~LD|#%`NK@4|3rICT1gYuQz2?o{Y!3t{~rZg8TZEN4}C z0NFhS4PVz}Y>K%r9px4qj2)fe-bF0^YHjv9n(WTJK5}pczXS&VM!l-6Fb>;jtTbAc zK>wvDj2JFDuA*@Qh}BhoWY_h{4$zT9GX>R%Nz*M!2arbiK*p^`yCvbGMUsmhg)T~` zogo2NWbfPXr~}*^P`(nPi=GphNo*`lsV|mWNcALV zT9G=LCo(Lc$(c{p)vLpUgeC#3E!-5SI2<4q|L5aG>&KDQ6FuD;dD&Is2 zkhb{2IeyUMrXlL3Ba;z9Ch9BN|Oh{&lpP3T)V)to~umT2O}(UETHGV#M=KbH!v$e0++(+CsN zSl4jZIVZ1@nNopF65IvlxKhF>5$T-|oFbj-96=Jh9ctiE1@X35d7DPBaSD)+;H0*g6&q6ycF7_o7Ecw|X6Ib0dkC_CeD&2k z4?8=&aA-}O)<}TCveL}yP3kxGgUUoI;yiH&aiWuC5M_T*)_gbr}=-st| zZJZ9OO_)~7+%}NDF!kg;Xf>^I7$qw`T-gJy4AHH+g(f9~Yxw(2pl-SRg!wfr8=mMO zCV?;L;%ft?iQ)j@x|yb=-9tNF>u8~|kQNpK7`dl5y417E$Ynes8{9URCTU895-IJ5 zXfeN$gmepw!q10Mxeweej^snobY3zU8wjP`Z4wJ<@b@jSL5`$!bslp5J**O@Yq>%d z_0hQbLdi?M!t9H9mHsEW9WxV>jiGKMeQ!=g11Yf_90%3xV6v_G>rUWzaJ=|>#w6Gt z!7>DF1j_a~&rQ84Qn+njH9Y0@^rEgU;RTPsTLbVLq$5sDYi4iv7pfSYk zd_X9gsDx|AO^DW24B~@?;DVWf=pZLF6g$J!A2^X~-$QzCY`9=kG+Yy0qnw*_=_~EN zmvYy&A-eT751Sl#79(PY&mVc)jF^}V$sWk(4;x?qGTBP>v}D_%V|3P5Q`KS5v8b{c=sf7;8 zFqg%9AX3{CQ8=vcoli2JJISLN>1js61v%7CNzMThI}#;JFoE~YZVWlH2&RkFfePwL zBC^c9cfypX9rvfb?57aJ6EZ_D5mra$NvyCy!xp?Lb-5yfL}CO8w=pD8^(npBqbtWe z0xUCvv>QNXDu@&m73$6t98wT%g8dU~(ucaHlfk$P7=<%SWg&vjyO`+Hl9|^Z7$A zOeO(-ugx8&LSF<0ZU{UYi$(r=E)z>S{3BcrF%?<<@A04krSP9aY&X{NJ*GFAU~Q`F zNp2ioI&(wWsc32Nd<&ggwXsqM(GTlAYEbad$|0uUnUksjzg3*x5Yc&Xb8vjKnM?>! zeF#^==usY-oz_FiVY|77gsk8r|G95&P2beFjv@L;uh@|)xJzj4aebFyE>LydpS;AD7Kmxcxl$Oc>#b9|?L=2Rh2C6xE zG!vK>JSXB`qb3?siIObloPr!}Ofs{EC#G+aQ~>t#!QGX!-OA zf#wb~D}+LF_GHM{J#CA8gfsC=llm~MJPCZ*5_RI6@5?mIa_Wiw4B5Dv}6#;FrRVu8jR zQ|+?GOQ9jvK@6*Cv+GW&!C8o4Q56s=%jKop=|6|B&CB5mKC>W1A3vz>k1ILtRO+cr;txw^|Xo7o4;1vI6I zA&x~YuD~?WRJ`lK*kG?PX+sv)HOUaUsmtw& z{ctGOOL3U4rz&j>uVP`l3tM8SEILA*^pL?ZaA@R_k_V?32mH)j0@U@J+?Gx!(Wd^w zI{)2K(vy=Us;57#LIjbWB|e)O+E#;H%DNrEe{_@$K&(}{)-vmwp^>XD?2CyX6{Lhy za!(R2Q$+KF-6fUr?s({!w4@$2Dggwpg`!?@Us5R)ic z08>>Z7#koZArTNXuS$mrlK>S+4a8m-{t3dHnKQk{ovDKfN3}$BhGK7s_R6T|S7ZMR z#d>?Gs$3g5+|N0|MJDBs7#%NfIJ8Lr?{*!TV+aK(mQIFwGKUd}%}YnaYZcDHmUls; zS#KH5QZE}E@72DIWZ zPDrZtVaRC?ff+sIP+_6#|j?V(2=p@p+rvTQt+G`62yXR5@5@B(b$-7-lj3+#&Deo1XCzPC>y*N3}&uX0<*I5PeO-4)iJc@c~< zx)tZNom4Dw^Nm(2y^EI>Gu^J&4&|cOwGd=fnl$LGy!#_PD3YeTk~BID%?Yi2hm{%b z2i4A&VXyz|$~)|>Ep7~d{0=UXUY-KDajD~JQ-3~tbfC}oRS+rn^3#ZiGBl2>aXSy3 z=kE{c+u4kIqR2Y}4Sj#O;urUZsUhW=y&vVEt*0_`OwyDc*JT?t%Au`m4bn+-N)kSv zK91 {ReJKDzsq0S-SERkON=-c09|2#}%+_b0t3Ya`yJPygodggISBkbAcyLjE*Yb3t~UOjgkC_x9x z0%ciuS;!aTIaZoh3#Ky z{Mn*dN(JR&aE6UjX}(iKdiHtp)?Dn+DT-#nTL!|b0~qQwX}hrXNf8(CFUUz3Ck@ZO zJr(~a$g9DPz8~o<709L)cO9H&>>POetiuW*8k;I$=Ny)+Qs(gZi0C>6uk}eX-yo2u z_Q?nPbZb&5ZAQ%xm3P5`a##*2TCphkfJs_WqJZj*G(~2M8EXJEwmy^-`Ohh+P)o8d z32-I3#1_iA1go*xr0xoVszj#v7K+l0sS|8GX(C^BPqg!rz>xH+2_DDrF2nbthIsV< zH#H9BPA2g(B$J;T3)c(AivPyJfRi z+O=6D@RCc02uj|UQPXi!$ED@sxGcSV0|n% zESt|!TTYS4n&=IT7>A!CxHRwu+mfH3gAvO8qtFqES*XOFv7wd=(p#vB_9p|lJGH#< zpqSTvztq@Vj38pJ1E@?*IZalBhiY7qD8lr9he#B2TuHSjNRe7gSNXyK0PN+vgGpJs zkbLPNQfDEW2OTT{tZkrJ@nZ(^`bK0RxEf-n_Qzz3q-$Mdh=Fz>d(I~bjhXwkwAbE#ajxzb1>IY4l z^bvM+z;j4T3J$DIIy7VdwwZsMK|r*zVIa~_TNNHxo0tP0S2=I_2a(-eij8|P=HCyvL?}NiRhz4V3H4+rb))2ccB9ciWLS?WQN^W zPT(mTz8B~sAx80&B>sLON)#-(m#)9@TmbJyu#(!n`HrE>x_o5LGmLwS=iWUCJ z$va2Lku;fU^K=pV9ZU+GEgLg3-USwpMBrAY=I;WH;6Yi0ua;BiM1;*Za$JT2 zc${@R6iaXXO$zt4A$&3Y+u%vBVd)u=eplj0mn}wMdkiGxc9f9m>u^Lp+UW{zO)C4HEw?2#b*6zx8Zr=L62x~jL8Fw9ewU#DT6 z2*_z8*r)u>2`PabRe88wRb&m|lG7)<>6lSQFjIkaL9Q23Uzt>(=JC^`hy_&9mX3S3g ze17Fpzc(+phd*xqX+PyJRJCh^kJjAyxsC#TvjI!a!vE8&T6n(QgS`~w2z%4=KOB=O zOc^0f#tPmk7=p}tBKZ9L2|iK0{8##~GllmA*&iR^$fziT2@EISxQ zGLAN1)CgHfd88>D^ZAr(@ERBCxbY(--zfXMfN5Buyr+Gu)4y(Soad?6Z8R#)^yd-d1Gau#{Ee~Msa8J!f(4)&Iuag*7dFBY{{PO+n0{8c6LZW zXc0MwtoFq-a*0id_%Bpyoo9GGkr%%MVY0J2^%QkbqN@4u?s?hn+AH`F13?4^#A;Mb>1;*iQ3? zWVEXstG~!WJRHWQDK;f|Fk)?ICjzhBxTBHAdvK6uhENYbMuF6@1MTCxZvsw3zrQ$J zOz5FIQ%d)e#61y$oe{ac&>Lpoui@i13&d%*oI~2`;BF^@9lE)TaSd!h)6Zmvnvkzv0aQ!JPe2 zQYfgY&U8F5gc)97Dyo>h3{uNTN;HUU=Ks(RQ>BZpSyX6Z0_y8r-Rw;uq9K7`?XU-A zN&TrP0B4W#eMpL3Z2WUCwyS)=%^hu6L{T=aXqbHpi8DML_%mjFVMj_&iaJhG)D@fl zqo#;3tB55bT78Boy=Cx(j zo3jc`p8rPKTR_F}E&ZZ{Cb+u>cOTr{-Q8_)Cj@tQm*DR1?(QDkEl7Ys2)UF0Ip25B zefPa@t+!Us(0g{%T~)hk_m-+(&9K%l1z=o53Xca5dU8UBr(u%i*&Tki4>N}JEuo5N zC)XxjPCN}pufXoP=W3PQ&0n}ZgqpJ4D34aE8(!8Psn%03 z=)^oHDl?{M#*$Lz#s)xnQ-!BRVF|X9F5H(Wt6i$v1kg=7eB>LzqO~iUP2*|&}=PoYMg6(K!GRgs+J#QqOoi;Sa7Q;5Co|fI_S}ucxvP=_qicnw#6kW@3 zkp{zDnL_T3_or*9ODt z)x^)|EDIxq5q1-Ul-hD}%ES%rB~f;2FMx;d_CZAv8I*Y@WU_m9Dcb7ng$K)r#ymf* zI8#4L@%SVu%SJZZ$>31FO?neEFnH-NaEu^j-s}fO4J+jH`q<>B1PPl4Kq8r%B>A1f zai{)={(nNQCWh?fO zr|<&7Sx$3Wb%jBIFqi^ko)!m~=5g}@VHJg6q+EkZR;06zVq92iQDQG;7oLS`b)TU+ zjjnfkmIptt)LjYP98~MrQP7jbywS>2e#pU%vVb`Vhqa7F$uWQ{KUD7{wr-WD&nQ$F zt}XSKsR(mZ5eL|Po0c=OSA>fkZ-VU7sDhnDi@(`5{-Im%U?#DxZ)*u;oMs&{9+66s zgHqF{XSq!cPg*Tsk_)GHxiYVXdpoJWu}rM-;SXRc=uT+C!&kRxqT#Kj^F)>I%8)7d zm8@U)gs%V*7_@Awv5**8Z!o;HHo3wF(93^F|Aa#vKs$jZMHI{eyG9W#JK0#=%Fr>| zAH=8=rpo0h{az8703Fi#bn>9fYGeaU<4fo z+M?-Xb7oo)%YES`ZN)L{Tu;J3dSb%=pKiO;V}AGG-o@yjK0CO>F;WCEj6IK1yzXEI zml$D+C()I-XLI!PknLXM?%a}~uhEC1ho7=qowQGOuH~KxD4Bl%GmJhZ*#4PduTy0% zXqsBIxQn=+Nh4kQ?JKP+V6kE6n8^;F@FtWaVUcwm*%w+!qq|{if{&K$LwJJbS+PoF z!_Eh+nDa);R&W;PQ#a3U0zO)RKLA1Rxf)IcvD4d-THHSXEAh1&Y@u4Z`90p_qHTTu za@%Jyq)S-CLs`~|1+S#2n_gr)W~xNkRC**K$ncrLSiIMD3^lPKR$or?p@w4-i#kuA z0-qn(hNsk<_f<;43*MXVwP;)$^MdY9UmSHc<2!!4thEy@KB5?2m;elX|rt;kR12=94?mIjUMAP zOg4QW=h2+RjQ$pJSf*D6<$ltKTb76jX+5MJxX*U#JdX|V+!plLGTfKBJec|xGeaJm zXqsrJ{<5c>dORc-3U3+EyV8^jLq{9(AV@Z-^UVViH33u0HA%YOPO`$84ROdpT=z!W zt05xj%Bikeh{LjBGBR!m%91CY=FE?6RS*M~8Y5;}G*PhZBRR9dXsYwi%r@AF9g0(C zgNf0!9HjYKcDaSf{NeqaRGk7J^fs(-{#Qw|50N>=otYS0HDr&g2%J9Fnx?m9mjEr; zKyr+bcob-gDo4?X&JokwI(!rAA?O(Pc!sP|`G)+1L$mQBof3flz4^@q@+_xB6y$7J zl2$qbC-$hc>r(+3V|10+fG_ikGS47r9}YsZUWSSUQt7z~y!Mu!h~2FH-d-gUaGBOK zI`%oO&W&ZK-eOq%b^>pGf^^2@9JVX`o7~_PkTvusM)J{F)wEraBlmXbRfhT0{AK`I z-!2**CYNAtON9@tv@B{AJSWHS9ePnilhnQfAxrWQkl-gum=t=kK*z66Q7(M*M%8jH z%R*ElJFvGBOsN*vCDg>qDE(}>7u*qQrZUPTnIcC%7|<0PK)2SJp`_dLJN);y#t^|u zn|Gu~8uqt+g47@QA(kT)n$%oQpCZa3&w(9@Fh9f*Zum4O{w% z;;7-1J8)V@84Inu%($l(UhDej9k?!_lhP@$G`@Td_Va%I(+Iy}QBJffXT2wy99+UF zsz?JMP&=Ve?2bakv0D}0G>HXHdGrX?IziVP%^jjceWy?q!8+A7=L!%&A56SrHM9&0 zl3UT|L%D=uV~dwAUk_7j#sU_wp$}tGO1G21#|`R)$H@@ z;lO?X1(A?oKhb=ZO*%DCc{BqE0StHo(^#{hl7om5=q?{KL$N@8tL)Lb(_9Wc-<)Fob6JDKd z?^EL=JS+VT<4mX`c*h%urcs`z^N(bBxMC>9Qp%)pG^WZCQJn$Gobde&gTx;wY@C60 zxy4dHTjI6Fx7nn31_`#fBqQ&t@WRqj$Ui|0%9gf`%O~Zt?>`lsxr{5u$dQ%0 zx1OA$`6v(cXKa9X*VjYZeBL#!qXUqmku zPL#k85!YCT3@nFG8(o+}j3Oe!)vkg9a|(_>ASf>HHA%qGeq+e6xm#-gA{i%Qin8f*G*!VAOR`Bly{6&{#s?qMH^)GH&P^Du_aFb$f5S1zN$R@JJ8ro9m6k=!1e8=?Jg>Qqy_%Hf7s3;6)Dh z=Qb#9p9=7+0>>h7E)VU7Sb?km!>dB}uU7>pQ3B!O<`nI{$lqyY*jQW0AAsS2)@uAu z{2|2&Shva(_j+DcoRI@4Dr`6lTzAt_yA^85k4QBYhe#9%RJjScBa=0bQg2AYPnMjF zvMlgDl-Z)(RQW3hLEE?c#(#DlS+FU+&J`lahDpLk3sg91pb|7j-Ne61SD>;zka&Zq zm$v3K1|I9z4d3)!hX}vd7RmoS;xmw(_m-M8krZ_bxBLtNa{WH}MSHZ(!9=bhpgaDw zZRjpU*69sONb0@3uE<}oH}>uImFwa1Y#txVKJWa&^hpKmI#~tsi_D zOKpL;&rA^S`xVZa5T*$`j8-27IWSwC{>mv=8$aDz^+iCMcK;;wxFvRmIiA4QXCQpDaY}!G^hp-#`q#Y5y;gC0FC_f=u zlPn$-v%BA6wgS#Y2-y67_lr%x6CKCs3G`8*U6SinzZE+l^Vtj0T1FAvfXZwFUi}txH8QiGXsoL-_^E$5FG~n??LUN{{}|KN#6T zO+__B%BLbZ@}j&~MUN1Kd?>!1zk27d@zYC?u*~>~&@ybPCm!!PiT`8Zs`t-OqF|S} zPx5w^g-2P~tYXblliPiCvm0df(DyYi$pl)sS(chRv;q1Ck-k;B8M3#zti;f~jt z@@PD8xb+{v1wA+dixUkTfdvHt4F?Ge1%LtvVEq$;1r37+4#8rB#UlO0!paU*#u3KE zCgTthB^NWMbV~SF22Dr^h>zfr>s1&vkqHy$%x>jf^LmaM60%egD_e7#VoVG;W8>|* zqiw^whg&)!eDpfl*{yzO#Z0HV>0qQo{T%cinKJdU=Z#F8I+Qw0J5PI)mLj%q-wAw) z0rOG)MsPQX?`Nyk{=WI?VuM#E8=^rnT&%=mBQEsEMP0ifI3^3}qP9U@@uFx!>`4v2 zbk4=i$pslPBuimnVr$&$o)nQ(REzbYSwd^vrn>gU7A|~v&bqEmiNSgXgx8badJxp4 zJ>!qXT6;t>Z`)1G6ds$JBI%7#5%h_k9tyNdR(PNVR=+ITy}emX!p62U795 zM66??@Z~c%n6cXQdu=>pRaFlw+_FZM-5wHPhGs{T18d{IPr2m74(d>;UsPcoj_U?cPs;H^i8*FRcAKrB1=Uz#>Xj* zoE(BG&mvzdtx(;Yy+W|`{QpXC=&$sKNp7X-?lJh0qbA2?>)UhHX&9#6EfSYfPtt^; z79q<6b|3yjh+Kb#*l1RD-Y9gfH0c4)CsGKk`S33Z8vK=DSNql{13ID72~d%lyfbhS zdkO#0N-8e>NTr$#ycJkfq(*dJA`p74JNHCv!B@AeN9T?4O1xThWrz=azZe7%9z1^+EGo-qn^-d{$SNrTJGuuUZYME7aa@9;)JZ(<-1kAAi(jg2Gdgddm^&z(CX{{~L;7TC5IT19E;a6pj8J&|USY-=JzA-sECEIeCcdN_h;b+eZ~E4ptm^Vx|NsjPoFyW&HlS?N8+@HZpooFP1F zSl-}w2~w0Qt}krV;p>i@{l(G|5{tchgxZgmFezdht2+50eJ^14J#W}9?J_$%k=_8)k+nyVRQew~Q&F=icqwTq=X%B7kK5{?s1Y7k=~TKKIkJD%+-t#g4G^&5uqr@*q9@>Y<|sHe zz8^pA*S2)fXy|mL9M%5{9PWG4S0~TnBk;;J@Y6jsR9#wlK3aJDeSP^3R47-#Yo_j{%W?rwh`H-ZYVeaZJK(nwekV{igcgP!FswRKQ!1v zu*QPYPVEK~Rjc!94OTW6Sl0Vtix$DFY^oo1K(ZpLcv#6pE!OS%Y*S2{D1984^1Wc5 z{JUCjxUk~Gr)zjjB#aWM8mJu!&~6Pze*U-LS8kYum%Dq0{qxgfgDt%J{eA~V2bsdM z)Y>D^1Sz=}gN0DN>B}7XIJ}_*ubNrX9AM8gwmNTC6n2>cQ|Wn`?IQ2lVjI#ccuf8? z@3myDr+mK0f@zS_ioyvDXBHB{>uO;0QvZZL)pvjwX)0+%G5Tnn;HJ^R*Mzm#5oFo; ziAv@Z@cnbH#a1|cRgA7HloCqt0km2^x@c!2-=(OvScj$eaSlC4Dq2@PfNkHO$(C3 z5fZwdh~mfj1MZ(8Zyl8{#+Aq|%#1WJ zTDtR~8f$tHT@>DV@6})fkeg&ie&P`d^_zdwDY@L>Lq_UtZO?-)MF|(;N7t*7i)U86Jb` zTv~#r&8?=^C8($LL1WoQ2m*fgj3FvNi3p#k9jA_Jl0D=28CvY8Zl%IJ^mhm1G_o9L+b`ZO zsREn&1mSuihjP4mm(HL5}(0?X$mJ5kX8u{`_JrecCzqt`C(I_KsMi=Lm_T)p#l z@74-{Gm!m%{z$&XF%#AWtSd3|IZLpy$54Vuh=9VK%ojE{g<-Xq*jF;?pw<& zZZdE4%WVzq?X6=9udCyRjxf%|)3cCFGHS=N#~<&#U)Ppi6S-Y@HHq-`OOhy4yK0`1 zm6{3sbHk_YGHmmgTHJ;{aUOwkx6AkTGXZ&^95*9VLyrD!b3+1vMye+Q{og2Fd!DeD(O@ z#GMAiLz^bdVqMU^w-moue{+t$XpPoCtO!aqxe_LeP&jXIO@R0lCffc{Vl>=Io)*( z(P^-Lj8J8L>m46P?LK*cXwaeS&_Vq@udb{1e>{p}yWT14`y?n`a21oyDPa0&-NOFs zQ*`F%y$(C(=HLVU$?k3n0$m0S^&1Xe)RP+d0{~A;h0wtBP)Hb9L>MUOe`cis2mmA$ z8Y&nSLf=m7gYJljwf5 zhXXsg2_7$JR1ZPn|G!@AowaipoK|iZUM<0g zjesU`D(WF(hOwD9jsl;?Od?JfGQ@aO84;L}Wxhaa)jR{oS9llrQ429V6qEz_E?U|Q z(N6nC3ogk4UgAih7E8$#3yrMChJ3&n$C75*alzK7YL^*MgN1Y~;mnPpqR9;R1bIs+Y5cWOst;kSP>7p`vlaQ~{h=U6SwboDT z9Ha0wE&jR!4{#?i6)O5$1Xb6RJBYIy@@fP>RyXgm`3a%K`bId2iH<%18(^NJ_~V`n z^Io`ce!l)+Pl;|atA6?yYb5xq%t8`hw0t3Zt}%_^2BU-DQw*PpB@vo1ZMn``1lFb@ zh?ZG+(4B3b^5s(w6e05q0;~s2Y1iwuW05vsVw7zCr0pF8l3q;G{fge`3p)(ZnhlVa z4c8W`y>XeQRmyh@m!BoY@j~|2c9yOc;%ne15(*x;;aB#sf`-)^j2rL?8WC{wmXXcb zh~F<^uvuV{kKJ^B2Gjufeq=6~nS{L;y)ma2|Ag@-A6D7qe#T#$eQFynPwbZ3K-V2h zpl&e63L}}%uLUqFeKwSHmu=|BiquxXv(U6&L4b+SRtp-ob{MCru^M7(Hf=W(^WaDV zrxbK<8MEbI5_P2Rg&es3P7iH3xWwD4GvLPPflEczZufHAmdxbgi z+B2{qv_Fy`DZLbRREKYdgniZ-C4A1ch zU1-#JBel800)sTv7%#R!jz&xKBVv#=(eC`~vF_?x&zD&k!$qw8pu!i~=wmwOl=5EH zB5&E)|9uMnl`Exus2lBZi8CxIPo%Gc*rcKis?FD%ci>Ca+E)GTHhXb=RJX`#fG9+)YDz z!=}8$C0#~XWK1rIO{0t|0*xw6ikeT#J{XwEzlsjH$lBC*HI(^K39@ne`^a=)oiZ@edc`tiBOeM3p#bohJrt9Gr#uNH&dF~6A5IC*KH%{hEw)7uy~+GHtg zVrRNfd`wElk?XH#ZoP*9z?`RbzBQPKrkjE{D!iEoU_JEnm80WKqE3 zhsMPw{D{6N5XM9+#S#98YwK~Bfa9=(;=5)K_7QShYYui}|3ZVJHGV{2`ClPsdC1{Y z$(Mrp1+PD$iu(|xh)3JLpVPQlZ^9pPiGf}Q(ZW**POxh^e+W^I?t~w;Z_U4@6MQB~ zB0Xx4j7Chzju8gPf1n`D2cf6ycfhz{Ed=K4R?`pf^9If&_1h0 zQ~e~eGB}rTElFg?*0Rf_q@StzYQ|P&K-{j~8+~$|tYeF;y=?7G3-k34AnM?&(Vf29 z~%e(~sow#P{}S4R?r z$V3=)|KtanXDljM@WgN|I#z@H6Dl@F$VJv^Z{JHbU%$SiT7b|GKe^Z*lnLjyf)^$* ze-t7U&KTHug(5QqKP$4i*pmOX%N1#;GaKZ_&tJTK6EA4=9n+B z#Pbey+X&?jD?_*!?=N%L(XeL`-IeedE&Mm-0Ja?Y&>)au^p5nR<*0&Ns3L(zhr`^+ zPY0(o^)d>c8UEPM1jz}2iN((aL)ZNQhzn2DnR5jW!7wJweJOZ4deN$ldvd% z84!7Z`7n+7|9Xl8?K%r_MWTv>b2Q{A5yT+WdGH6IN%D({`O)MLpz+^@kLzYQ;wG=? z1qwIk{0R}RH~sz*egE1~fPjVsK*4-~hWOXm4H^vU1_OXaMFXN^V6w1dVUx0P2rGYL zr4xUd(LF%mnW_6V06rl^(I|BHM8M9ON(0OZZ zw%h#dp6cK{J$)(NWi#{M7N0I1oyHz>J1HlM46(omdCTc9-wpTd(i09$ zNOs2*5`iyG#7!wdO*p`&6tyk*!*|b&8#$N;G;E^9BCb2a)^P|Zq9IinDYui5{T^?0WGBxO>`Em}0X3DYC7tC1IYFYle z(6nq@19>^_ggU6YM|Gb>zwRaS3@FXXK(Y@PSE+|jx9x_Kada}vYfEs@Q zDm61%eplGyUpx17&*bsS74i}E_4a4nLW5?hjv6^>iW3*d&&`vh=9kz;j5wZ`l|$jt z>50#F)>>)NwF?tT9{PZaX*aOGCOT!la5^2*mDG`0gq|}BIxLfd*nGoOUL<9c zbv0?g?NhBR1|Au`Yq7)75m1Y3%$fF6N4zUh>1171Vs!WCJ(yZSZzeV?&9WLD|!cQk@3N5yA!LvX8%>3kPsoHU_A z*DSS}>50FBTSe|~tHjQ!u>*~?yEltZq!W+DX$3Ou^tV1q#K_e1@D+|GGacPj#(KhQ zqkit+Ok?>OAQvf+ZjlTwL+`h^w7@gj{t=O*EY& z4mv-!kny!+!z!frdtXyCYaSil4G9SP9?@^{dJ^{>2dHP? zR(SQ=@g74hbAM1;?$LES%Q(P0oA5OQ6*qQz5=cVOKGsigj5$zBpK_4Z*eOVevdg@R zxq3bJ&wy$nhCaX0vqe{H9)DG+->)X4#PUaaUakh$Xx{Gjz;72{VtI2Y)-?62Vd$0Fos^iH{g>KMorU%iiJbaKM!D5Fb3F~A+S9$RsN9hd z+n*pKT=YxW-VtzO*S!pI+Ub>@F1p0(uv)U?1_{9Th5a>zmNokSGK5|N$@*W^Uh@&e z&gR->GpZwx&rsCcn~xamnlCf^Zn_^4yJ)F60!kT#8o)gy6G>V#GJT+owVChlFw5%UlQn@z7Qtnh1|<>2ukCZCE68d@rDn z4MlPfHms%k5G6h@B>Va43NQVhA^k&#+a6h#Dnc?tD)#WB0`)o4%;8$yB%UgL)G3oA zJK3BOvdUxBcGGz)Auuo0XvkOTapf4Z0%-)a#&w=(qz4JM>0ZJGjI1QwQZQazE2v)m zSpp7YmDVg#@L;PvGZou;wbR|_DI>9Jo#Ox{y*mr{EB}J{c#$2e6oE&%k61Jt>rIrT z^n6^vLM9(`yvgVvz+q8vUo#p@`4{10v8bq=1@~<3OpKsxi>5GELJFf^1RN)pJCo|0 z7&`vK7JD6LFd{muIoe@pmgjtGws^>h4Y`^&Flgh+LPN5!ax-DDS|03206aCJGAOg$ z9O9_h_?8W;O+e)3noPc3=bF>0v`COWZChQNj(^HJ<0G+kNlb1|wm2xqZb|#Yz_g9w z)jk}_szB>@mrNt5RbN80k`AV0rJIVsDw=wWgjKQl66oFRIU(t~4+iG=ZC)(MM>jxi z`D(5Jt-|7!X0sRhj~oWPK<*cHYUWcAUyQ{?;v_(+RYMv`x*Jm-Mz96z3R9t^wiXFj z`;9S0o3b~k!!IXMR3sQC+~b*l`>%G`+88r}c>Z&;8>6g#St5Pg-{tN>J6cE3@(eX; zPz;JfO$X9}htog57XSX#(GpRjE_-t8lp7T>>5ijaGbNa9GNf~+@y6MJ*{RCM&rf2S zJ<6M0t+6jw-w;9cFhIIA16_n~?BE)fWmA^8s8AkIrXP3wE1D%H;XZH9>T9Hd@$pdr zC|O{}JI2h+OnVlmxl#HVn?6yuGOnhaYEbfsWei$ngji3LZQ5ZJ^V6sChB?4PDwz}v zqZ;Ug;i{pAkG%PnEdT9zgG|k$9A<=#rp79|cFvP+(JZ%ltILOoa>^h*SuuJFPyV7c zDke=uT{1Ekg|Gs97~2sB)&6HGrYk%K-Zq> znhLf>ODW_T9ddel3HYqWNqXJq3F9?>sEj#tJYvLU0jYw%|zYRUir8~$++-)D8M*WlNiz);jY>+s%E|N z>DZ}y$O8{gTD_+J0AM5}PRC!c#ikM&u5yj%Uq)Rs^@Y84K>@k<#j2fnW~mkas^yv2 zuQ^Y@6@C251p3tSb}Qx_mrvU+*tZ^eu3uxo6%y`R?1?pR!{6PU(OP%+K72R5lKqsmCR{)xUu)dZkXHvg7h;oC#Hpv$sH_hc@lqOZGMc6 z?wacSY9+fia1S`Q0tv=UZHoR1yALsi9_|pW)Rx0;eW3JT5M!p2e4J^$4kV zc08;a^=Oh@rRBl5o_V$~^EyKuB^6p#s*@_VZkc`6BI!snjt86945Re*D--Eus@uLs z+@ZM(l~nRBD<`y(1R3;~yI`AnL0b%ZWb#b|8<|vSlUN=U^4BXmU!c<7z%X z?%CZ`CD}`2mnq^7^|^1Uz=pT#Fq&Sa4jb}bZ&F7Rbl!v_-}f;C_|ej~36RDONSEdc z)63ZEoBaC)p81T+%X34@vxesSP}@c_HMZt@>COGx{<;DuQDxr8Udo?XYH2RNd0yJA zq;(n_zGRh>Uj<1#ERDA`h85#Qrzre5Vyx60a|LRcQ+;%}x3k4Zv8bnSDcwLQ*F(p< zgCX+kxA8%1iT60uXVYud{k9_&Z2SPst&bMd$BS7S2_Di3@rb`lGENP;1x zOB@@;CGU?#d z{T7=viWw{Fn6ySuxW=KgseC)T+xiDUT3EcIG}EZ*)9zXyR%yLgt0h0Y@+p}k#mI7p zPiU-9$ttC9=9*pYUCA>592?8d;Gg#aJdte&WgiFCJ69DI*U3&cz)TW(uYqGvHEbMe z>TySwR`441M!U!twnFKsvECcBu$-NR>?Dq(UrU)M!Or`mT*tFJ|R={uh5Nn6vFj$Rxsm7+sM zeI^BOS8V5cS##dG+*+&7Br%UX-D}R^9V@Hr^T=Lbp{ZX*^eYwfROD+L!S7Nsa_?GJ z?+1Bt$%lIn-ZM=gu-DBJ2d9kaTeW|)4=`EK`e{OKIUa=OD^drVN=#&*4a%#wS&s0W zjYd}20@w?%gOfbfIZNx-lOE;{vylc7Yt0~tfpxzP=LpF zHt5=j0D4$*1YDKi$WOTSkOI{QPAd}TM5hQB}A)j1;A$TyZAS$cbg2xGnV7ftz^5iw zKjH-Hk3J(`$MvL90A71adzZ@)h%ZgxsQcOJYCg1K$plYtF#PT1UYb8CT4eOBh5LDV zp8owhu=s}na2~jp?UG-PmlzmW-X}lw@~fg?bE~{~KiV~}F3NChw(fs!M5>c84@o=Z zuueS$CFe>3i&_SB>}!cJH!akuF+M4!D0y=>nIwn^eA|L0=KDk`WXHfARpZy=Z@7As zdWZOhqP4UZKTzHJ%M|i%JbT-59gd6Ji_j&}FT zFT1|Bb$sTvp=N4&M+49$3WO}b8oc9IYqKJ1$+CvEN%%KkNmop(x;4G3?{p3t*beYM zR&(N3^r!Kq5W9(siz_u5(*F8O1XqCpP@jV1x&Sdhtc?*w5wBS3fz#Za`YXm4yu1%{C;K7E_4JwWAQeduPZDwF62*>o4ULj_eP^q9 zyK?Jh=oxJUM$mO{iB=q{!l4^~ZM|IKVHj>2)spWo=~G}`8qzUsZNT!UY?kfi_9#)g zu18C<2zMOI+P%c`~_RU z>P>%VbIcQvjQ_LxPCL_op_<$FyQ^Jl#S3F@Pd0X4Mjt#`-C0&YI+XU#bKLm*$fwI8 zO?dGn)7=-wS|%lAqlTq?9YzxBq4wFt6;6Iwrnd#tx00We3U-xwrf>MxppWe6--BIP zsd&+{tD+k7&e!g3!HIbFl!*-W4j*tLAQX)C$;J86qM?-~h96Ao&{Zw+Y~;vfjO0Hw z4Vn?Xhy?@Ggr!71(W?^Sple_Up^D-@glY?w4P} zb(<5<)|OVGRM3m~em3<*^Zjfz-6Fu6ZX+>n&+Iu??Cm$)I0b{-)PWb#B>uYPLPEg6 zBSJ%efcP)BTr_lO@D8X71{s@(s+x&&!vZ;ru&A<2U}8aG;{d68(jaC~(LM~jv1vkb zlbG4R*VO*m1yn zNUS(Z?+ZH40x;@vlM?YXtv~)&tTU1|*va`ywlU6%4pg`DV&<&#(|*wo{mEH`4M(W~ zqKu8z!*uGZc`EP06_S9ltD;djxWG9S5N#a1n>=DO(X*{4M&+@S^Fyj~**@|CCXH#@ z;Uwm8e)3f}8DKbzHE(Dlu*5y}zdwLoJLiM3Fr_?@UIqv}b4aS85C_!qMwE?V23>q9 z%Kmiz% zBI#^-ld_G?4{6`$Ijs)=Iz5$nKCem4+vK%KFsg7niRqqZ8bibV3{#%eiWqL2#kV0M zwn?u_Yqm`DEjOCDNo!kq9ij+B*#wuA7sJO$1=DU)LulJtPnXYf4%@EMq3W?2|KdvEj*4U($6&Z7v{_58Y$(b@ z)+l{o$2Wng6ZmVsK~>}u(|;;A;DYquY$pE)oBap~UAeOKOgiHB9;z8$HAOPD@_n|a zf@54viUUSj(HB@XF5Vw6hq9?;ta6>dEpuY=2K0!N$4L&5F$EB4leM3!|MuDKOL+)u zrQQ`{zSa+|<7C?{-?|n(Bqo3Bx*AerBXP)jpcK0Sj%N6)3}t{~crJY(8K=b8r4*Vq zMTCA^rc_na6r-6kFzOfS|MEcGzI<8}`Xyn@0&!zzbbPLLhRFEY-Oa>l(gDd_xjV)| zCxy#iJc5%3ps9eF*9m)Fok?zmZQ3jh&`;LK$=vuHS?lGY#reCiL*Ylxmc{Ruxe`A^ zqv8{S^CPO?a6Nb(Y`?2=1j7HDy%!slb|a1e3sfrDm`hSyvV0x0VFCo(_Ud5jm{Kt-w59*5 zb$tA)=pg4S#r0R~!s}0tC)Vj7RD4C-nL?FRunVjrC%GCUp>4^E->E*;nD6`GXBW)h zCR_=s&El_r{qpY9N4HLD&- z>9G{s7#}1`TnT;4`L@TGd2UE&f55~=pnWluj645w?){Qq=vp7)4w*E2N}{=VJ|dfN&_(5b&gH(HuQ`=r};x=%Hpvku^QPCjsP z9yZA4D`vLGK*Ce%F(l63ob@2^>=LG0yJ!G_XgLOsHOWY+_m9(Kx zadThtSgElE4ez>^mgPOsR(O;Qo9_;z`efN9Qn2VR7h+FQr=ssQH}=+Xr!V6qwx^4I z%*>0fE(8}m9c=HLD_!}&B{y0^6X#m{wN46O!@lHFD#S5sp-QjAV|+oX*1iJPXtO+d zD{@E4Cnpan;k*Y83#4i-HreSa`A4A3)aA8vkhA z9{_qgfn+7QSJy&IdniGY3~&y4@_>!@X?>xI7MdtTtx*xj7gyE6e@k>dHr1OB2>%~K z=w3_oSN?Dh@8QjC(Z<)s5_4-4^Smytgtjah@EqIM{gbwNlGpJ6RsV z7=d*CffvhMaFR9W8j^6R+ss?_(D9W(Yx|*UUfXKeSw^m0v+M?+VA3=F=6o6542*r3! zspTVpk5SNQ)%dCjFNF^Dcz_ygSp8%yS5T> z#_YE$<<6e#kZAmv3a9~c&||DQj~KnuCuqrGRNed}PImnds>RVr&23V8Xwrr#oXQ+} zWhOId^0^9w^$p3t!1fkVt5!?|QfcJP#sVh+VPn%Cw-vB*NGHltx9mszf0^ z`4PE92Kzi8zMeFA6iIR}8C{ker+$3}4bJyRh@-lu978n1=6GmajpfQaNlGEZq)rwU z0A6)^UK#*-l+^N$lj^_tdxe0!vSlR@+A*%)6##~-UY36$C-`5LU1>NJY}+2$daa3J z9!trLWsqv@j3t?2EMbVoIzsj>#A68+VT>`Dq>^Pu4Tdab>&Z?=v`CZe4U)0TGI`NA zy~q3g|Gt0casRuH`@HV!Jns8G&Xb&)Xe8_)t2<+f+(eE9E8TYxBAcD@>C*M#SkMX& zI!HmY8?|fzTrcyGetZe8SASt6a~|S}{V%Z>f%z})W&f&X#8K0W-a&oGZ;GV;0F4$? zxYm;+9i5_RE-B zj&jqfkP zX(b)A#Ga`oyt(VkO7Ot&R4jpEqyg~bmbhn|`4u^zhuQ*ty@ab&=*-C;FS!Z% zP00}ekL^c<-zClw7}6GmMI#NkEX_maIqI)%cMD0MBlki%Th}}bugJ~G#fs0KW*2WH zzF&W0Iy3~q!Y7WYC;h5$5~;fAh7Miqgo6mVM(@4rt-RR;kU5&6U;FRV0_N)R90FEBWm}huS0^1RH!+Ql>)Dd)-k!nz{Y;?mU(Ll;)4vng|hhX?kp*8nw^rGH;-=Q$fz7Eixxn6FY7;?n1! zm$H@(k^hEWjORKKGudEUuQg4RE_`cd4t}@vVkbsc=hpmfsmncRcPFz*EdGT!vvt9E zE?GtDxNenpqnuf3#(ZCM7ncyZG~Wy=lvkdOC8-YD_GM7L+vjB7M_8(NFCdGL5zn0^ z64xST;(HL4;0p_A>WxmOB>xq}@pQ0;qbbH!~>^>dJ{hCjTp0>F9>XOOg#lj0>ED3 zQg6vafv^X(s~S%o`=MZ%JfCx9f;dH`LSXp7pl!wbLPr6CUrh?RJYtcx=#()0Pw5YT z;=qn6cT*{%L}~Kv0N<}oS*1l9X5@1sZ9K0ZrSK%Ly>W}c{;dBaM}I>mv#Etj~Ewh%m_!Gu$?c;G*lAl z5J{~Ru37T3f$LLxXYa7|yFrP1=M2m|LWB#+!QbKi@t~LE) zT$LN_07xkKqJP@Erg4`+@7Mtz{RWgb^=*HFc5IN_i|PmX6=OsL%Q~F?dGabyo0K6f zWbg^Nev9bERIsIIcD1_hNlv&ck(!V2!wl8M$ldw1K zyMH;vvYbH(K&4iD3#u&ESFeY5 z71fX|XPe^lh4z-i#NHdJ6zi00Ewnsf(eo^XsqBo$uy5`gwHfhp-s`Qct-w4pWrKy| z+$CXc^fQ_`S9D5C^JNY^0vC5)U^NSRB&W~Uu7nMJD1)s2$?p}VGjoHYGo5hTsTi15 z>Et!(wkn>i3*SrYX!rHa9@Sn*a7J*$FPew=pzSqsB{tm#L^F*=lvHq^OG_Y&@Y|7M zm@AvWKC0N>vwm;9Bd{hR9^|QiwN2ME51#*cyRCX48itr^MYbiq@% z4=(ktY`;>~lh<4L4M>(EjXNvOgJjnU_Ow^~;Zu(PnwLCg2=hFuEAv*Eo)9TF5%)&8 z)l=H8&gLB`@V>7g{P)P1E4R;-k?^KHnw;5;Lgs3g>Rk#NIcqldK_My5h3%)}*DeDM_3+e-(|7+*K~X1G(iFaCtRA?39O|vA6_50Zd_Fh{38*N_DdmOK zmxU-ebBi`(p9y6AXGNWwMpMF`-+6K#>Otm3kO9Se7@)*Ee;aQAh!h^&^zaQtq*Mst zxk}E)BlFCDxf9j>OzRZ(*Mh|@4~~DrEd7wcc<4oT9FN{X4-y0#;dg}qs!VunMV`J^ zK|kMtfQx7zQ^ZnIZv{~aaS}nl1L(?`vp>7!=DKg0bmTauLxEE*1<=0>7&Euu$j+ND2K8G0TYxmgMx(@$vZ8xZ1?{SGOusNl(auW*Aqp5YVDJ+06E1ch!KR^K@QHMe!ZO+s%u-(u8yt=7~Xu>#Gz zG1hB0!u&;y>+J`bP^S8pmF!(-PP+CDPR6O~ScgYQ;mgFR|K*It14@*i)Um}04*kU2 z8_uzmlYH3@mhEi0By+~)a%bD0<3k9#+l~NX&fy@)1aGl9)KWaxfEzF4LDsZELHBzD zwz`tKL-(roRVBqSCtctt>sesRcKE^84P$=J^r$baw0)wpAylw`A6YmB;nT2TWNt6q`#w zbji@}RbsG|ibh~gY#7({&YjEO#bll;Ak~c4C(u?LX%uTFiUmTb-3}Vx&)z$sTTWLE zz({#C$(7?!nm8>&?F27MXAPwnc0SPE@EqFaxp3WGd2XL1UB1*~Y*L|Xad|~7dV$Vy zbP$z>%hvwU8K=~WPpSF;S6aNQEdjpE9uCU?hE7zqOG9l`8UvMkblzKUH2be^y8jp& zbC771OK}nw)19PaBi-tbjGh$wS@7`7cC0f?gaQ@E#vY0K`GKBBT^l>z`6{-Xat;i` z-hwr^^5L^=@N3$Nr7jJ9y-uOal1a*MD(gUzn!@E~>N?MZHOw!oj7G@~qZOVq@^E@^gVoL`1~+`zrg4GH=q zhUR8rZV6ybF}5Kn|Ijy1xVyqnCbXR|s(F&j6nTT2I&B@6U)Momn zl~40vbNl+;CPGgwrXWGeRz#vo^va=%#z!&v-QX>;r?CzDmF&wICs&t^gjb+HbyAlu zMj$fEW+#&V8gGY(KVE`c>Cwx4@n%%k0e}1*(>b4BUJnY1Zgl-#TGDp0Kkn<2!w5~g zvI66hkuJCqL^qCJr{ynR-v56Ayn?5WKTl%wvo~rR^I$L2G3XIr$!y>eANg-P#SqaU fgzs%Vr*-jYG(YMS<ttdtee# literal 0 HcmV?d00001 diff --git a/website/static/img/docusaurus.png b/website/static/img/docusaurus.png new file mode 100644 index 0000000000000000000000000000000000000000..f458149e3c8f53335f28fbc162ae67f55575c881 GIT binary patch literal 5142 zcma)=cTf{R(}xj7f`AaDml%oxrAm_`5IRVc-jPtHML-0kDIiip57LWD@4bW~(nB|) z34|^sbOZqj<;8ct`Tl-)=Jw`pZtiw=e$UR_Mn2b8rM$y@hlq%XQe90+?|Mf68-Ux_ zzTBiDn~3P%oVt>{f$z+YC7A)8ak`PktoIXDkpXod+*gQW4fxTWh!EyR9`L|fi4YlH z{IyM;2-~t3s~J-KF~r-Z)FWquQCfG*TQy6w*9#k2zUWV-+tCNvjrtl9(o}V>-)N!) ziZgEgV>EG+b(j@ex!dx5@@nGZim*UfFe<+e;(xL|j-Pxg(PCsTL~f^br)4{n5?OU@ z*pjt{4tG{qBcDSa3;yKlopENd6Yth=+h9)*lkjQ0NwgOOP+5Xf?SEh$x6@l@ZoHoYGc5~d2>pO43s3R|*yZw9yX^kEyUV2Zw1%J4o`X!BX>CwJ zI8rh1-NLH^x1LnaPGki_t#4PEz$ad+hO^$MZ2 ziwt&AR}7_yq-9Pfn}k3`k~dKCbOsHjvWjnLsP1{)rzE8ERxayy?~{Qz zHneZ2gWT3P|H)fmp>vA78a{0&2kk3H1j|n59y{z@$?jmk9yptqCO%* zD2!3GHNEgPX=&Ibw?oU1>RSxw3;hhbOV77-BiL%qQb1(4J|k=Y{dani#g>=Mr?Uyd z)1v~ZXO_LT-*RcG%;i|Wy)MvnBrshlQoPxoO*82pKnFSGNKWrb?$S$4x+24tUdpb= zr$c3K25wQNUku5VG@A=`$K7%?N*K+NUJ(%%)m0Vhwis*iokN#atyu(BbK?+J+=H z!kaHkFGk+qz`uVgAc600d#i}WSs|mtlkuwPvFp) z1{Z%nt|NwDEKj1(dhQ}GRvIj4W?ipD76jZI!PGjd&~AXwLK*98QMwN&+dQN1ML(6< z@+{1`=aIc z9Buqm97vy3RML|NsM@A>Nw2=sY_3Ckk|s;tdn>rf-@Ke1m!%F(9(3>V%L?w#O&>yn z(*VIm;%bgezYB;xRq4?rY})aTRm>+RL&*%2-B%m; zLtxLTBS=G!bC$q;FQ|K3{nrj1fUp`43Qs&V!b%rTVfxlDGsIt3}n4p;1%Llj5ePpI^R} zl$Jhx@E}aetLO!;q+JH@hmelqg-f}8U=XnQ+~$9RHGUDOoR*fR{io*)KtYig%OR|08ygwX%UqtW81b@z0*`csGluzh_lBP=ls#1bwW4^BTl)hd|IIfa zhg|*M%$yt@AP{JD8y!7kCtTmu{`YWw7T1}Xlr;YJTU1mOdaAMD172T8Mw#UaJa1>V zQ6CD0wy9NEwUsor-+y)yc|Vv|H^WENyoa^fWWX zwJz@xTHtfdhF5>*T70(VFGX#8DU<^Z4Gez7vn&4E<1=rdNb_pj@0?Qz?}k;I6qz@| zYdWfcA4tmI@bL5JcXuoOWp?ROVe*&o-T!><4Ie9@ypDc!^X&41u(dFc$K$;Tv$c*o zT1#8mGWI8xj|Hq+)#h5JToW#jXJ73cpG-UE^tsRf4gKw>&%Z9A>q8eFGC zG@Iv(?40^HFuC_-%@u`HLx@*ReU5KC9NZ)bkS|ZWVy|_{BOnlK)(Gc+eYiFpMX>!# zG08xle)tntYZ9b!J8|4H&jaV3oO(-iFqB=d}hGKk0 z%j)johTZhTBE|B-xdinS&8MD=XE2ktMUX8z#eaqyU?jL~PXEKv!^) zeJ~h#R{@O93#A4KC`8@k8N$T3H8EV^E2 z+FWxb6opZnX-av5ojt@`l3TvSZtYLQqjps{v;ig5fDo^}{VP=L0|uiRB@4ww$Eh!CC;75L%7|4}xN+E)3K&^qwJizphcnn=#f<&Np$`Ny%S)1*YJ`#@b_n4q zi%3iZw8(I)Dzp0yY}&?<-`CzYM5Rp+@AZg?cn00DGhf=4|dBF8BO~2`M_My>pGtJwNt4OuQm+dkEVP4 z_f*)ZaG6@t4-!}fViGNd%E|2%ylnzr#x@C!CrZSitkHQ}?_;BKAIk|uW4Zv?_npjk z*f)ztC$Cj6O<_{K=dPwO)Z{I=o9z*lp?~wmeTTP^DMP*=<-CS z2FjPA5KC!wh2A)UzD-^v95}^^tT<4DG17#wa^C^Q`@f@=jLL_c3y8@>vXDJd6~KP( zurtqU1^(rnc=f5s($#IxlkpnU=ATr0jW`)TBlF5$sEwHLR_5VPTGiO?rSW9*ND`bYN*OX&?=>!@61{Z4)@E;VI9 zvz%NmR*tl>p-`xSPx$}4YcdRc{_9k)>4Jh&*TSISYu+Y!so!0JaFENVY3l1n*Fe3_ zRyPJ(CaQ-cNP^!3u-X6j&W5|vC1KU!-*8qCcT_rQN^&yqJ{C(T*`(!A=))=n%*-zp_ewRvYQoJBS7b~ zQlpFPqZXKCXUY3RT{%UFB`I-nJcW0M>1^*+v)AxD13~5#kfSkpWys^#*hu)tcd|VW zEbVTi`dbaM&U485c)8QG#2I#E#h)4Dz8zy8CLaq^W#kXdo0LH=ALhK{m_8N@Bj=Um zTmQOO*ID(;Xm}0kk`5nCInvbW9rs0pEw>zlO`ZzIGkB7e1Afs9<0Z(uS2g*BUMhp> z?XdMh^k}k<72>}p`Gxal3y7-QX&L{&Gf6-TKsE35Pv%1 z;bJcxPO+A9rPGsUs=rX(9^vydg2q`rU~otOJ37zb{Z{|)bAS!v3PQ5?l$+LkpGNJq zzXDLcS$vMy|9sIidXq$NE6A-^v@)Gs_x_3wYxF%y*_e{B6FvN-enGst&nq0z8Hl0< z*p6ZXC*su`M{y|Fv(Vih_F|83=)A6ay-v_&ph1Fqqcro{oeu99Y0*FVvRFmbFa@gs zJ*g%Gik{Sb+_zNNf?Qy7PTf@S*dTGt#O%a9WN1KVNj`q$1Qoiwd|y&_v?}bR#>fdP zSlMy2#KzRq4%?ywXh1w;U&=gKH%L~*m-l%D4Cl?*riF2~r*}ic9_{JYMAwcczTE`!Z z^KfriRf|_YcQ4b8NKi?9N7<4;PvvQQ}*4YxemKK3U-7i}ap8{T7=7`e>PN7BG-Ej;Uti2$o=4T#VPb zm1kISgGzj*b?Q^MSiLxj26ypcLY#RmTPp+1>9zDth7O?w9)onA%xqpXoKA-`Jh8cZ zGE(7763S3qHTKNOtXAUA$H;uhGv75UuBkyyD;eZxzIn6;Ye7JpRQ{-6>)ioiXj4Mr zUzfB1KxvI{ZsNj&UA`+|)~n}96q%_xKV~rs?k=#*r*7%Xs^Hm*0~x>VhuOJh<2tcb zKbO9e-w3zbekha5!N@JhQm7;_X+J!|P?WhssrMv5fnQh$v*986uWGGtS}^szWaJ*W z6fLVt?OpPMD+-_(3x8Ra^sX~PT1t5S6bfk@Jb~f-V)jHRul#Hqu;0(+ER7Z(Z4MTR z+iG>bu+BW2SNh|RAGR2-mN5D1sTcb-rLTha*@1@>P~u;|#2N{^AC1hxMQ|(sp3gTa zDO-E8Yn@S7u=a?iZ!&&Qf2KKKk7IT`HjO`U*j1~Df9Uxz$~@otSCK;)lbLSmBuIj% zPl&YEoRwsk$8~Az>>djrdtp`PX z`Pu#IITS7lw07vx>YE<4pQ!&Z^7L?{Uox`CJnGjYLh1XN^tt#zY*0}tA*a=V)rf=&-kLgD|;t1D|ORVY}8 F{0H{b<4^zq literal 0 HcmV?d00001 diff --git a/website/static/img/favicon.ico b/website/static/img/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..c01d54bcd39a5f853428f3cd5aa0f383d963c484 GIT binary patch literal 3626 zcmb`Je@s(X6vrR`EK3%b%orErlDW({vnABqA zcfaS{d+xbU5JKp0*;0YOg+;Fl!eT)XRuapIwFLL`=imZCSon$`se`_<%@MB=M~KG+ z=EW^FL`w|Bo>*ktlaS^(fut!95`iG5u=SZ8nfDHO#GaTlH1-XG^;vsjUb^gWTVz0+ z^=WR1wv9-2oeR=_;fL0H7rNWqAzGtO(D;`~cX(RcN0w2v24Y8)6t`cS^_ghs`_ho? z{0ka~1Dgo8TfAP$r*ua?>$_V+kZ!-(TvEJ7O2f;Y#tezt$&R4 zLI}=-y@Z!grf*h3>}DUL{km4R>ya_I5Ag#{h_&?+HpKS!;$x3LC#CqUQ8&nM?X))Q zXAy2?`YL4FbC5CgJu(M&Q|>1st8XXLZ|5MgwgjP$m_2Vt0(J z&Gu7bOlkbGzGm2sh?X`){7w69Y$1#@P@7DF{ZE=4%T0NDS)iH`tiPSKpDNW)zmtn( zw;4$f>k)4$LBc>eBAaTZeCM2(iD+sHlj!qd z2GjRJ>f_Qes(+mnzdA^NH?^NB(^o-%Gmg$c8MNMq&`vm@9Ut;*&$xSD)PKH{wBCEC z4P9%NQ;n2s59ffMn8*5)5AAg4-93gBXBDX`A7S& zH-|%S3Wd%T79fk-e&l`{!?lve8_epXhE{d3Hn$Cg!t=-4D(t$cK~7f&4s?t7wr3ZP z*!SRQ-+tr|e1|hbc__J`k3S!rMy<0PHy&R`v#aJv?`Y?2{avK5sQz%=Us()jcNuZV z*$>auD4cEw>;t`+m>h?f?%VFJZj8D|Y1e_SjxG%J4{-AkFtT2+ZZS5UScS~%;dp!V>)7zi`w(xwSd*FS;Lml=f6hn#jq)2is4nkp+aTrV?)F6N z>DY#SU0IZ;*?Hu%tSj4edd~kYNHMFvS&5}#3-M;mBCOCZL3&;2obdG?qZ>rD|zC|Lu|sny76pn2xl|6sk~Hs{X9{8iBW zwiwgQt+@hi`FYMEhX2 \ No newline at end of file diff --git a/website/static/img/undraw_docusaurus_mountain.svg b/website/static/img/undraw_docusaurus_mountain.svg new file mode 100644 index 00000000000..af961c49a88 --- /dev/null +++ b/website/static/img/undraw_docusaurus_mountain.svg @@ -0,0 +1,171 @@ + + Easy to Use + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/website/static/img/undraw_docusaurus_react.svg b/website/static/img/undraw_docusaurus_react.svg new file mode 100644 index 00000000000..94b5cf08f88 --- /dev/null +++ b/website/static/img/undraw_docusaurus_react.svg @@ -0,0 +1,170 @@ + + Powered by React + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/website/static/img/undraw_docusaurus_tree.svg b/website/static/img/undraw_docusaurus_tree.svg new file mode 100644 index 00000000000..d9161d33920 --- /dev/null +++ b/website/static/img/undraw_docusaurus_tree.svg @@ -0,0 +1,40 @@ + + Focus on What Matters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/website/tsconfig.docs.json b/website/tsconfig.docs.json new file mode 100644 index 00000000000..9ef3ac2ed75 --- /dev/null +++ b/website/tsconfig.docs.json @@ -0,0 +1,15 @@ +{ + "extends": "../tsconfig.json", + "compilerOptions": { + "rootDir": "../src", + "outDir": "./typedoc-out" + }, + "include": ["../src/**/*.ts"], + "exclude": [ + "../src/gen/**", + "../src/api.ts", + "../src/**/*_test.ts", + "../src/test/**", + "../node_modules/**" + ] +} diff --git a/website/tsconfig.json b/website/tsconfig.json new file mode 100644 index 00000000000..920d7a6523b --- /dev/null +++ b/website/tsconfig.json @@ -0,0 +1,8 @@ +{ + // This file is not used in compilation. It is here just for a nice editor experience. + "extends": "@docusaurus/tsconfig", + "compilerOptions": { + "baseUrl": "." + }, + "exclude": [".docusaurus", "build"] +} From e04e01e8c5103d651851dcce160c6180a92a81c0 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Thu, 26 Mar 2026 17:23:07 -0400 Subject: [PATCH 02/11] docs: add transform script, TypeDoc SDK config, sidebar groupings, and local search Wave 2 implementation: - Task 5: Gen docs transform script (6 transforms, 65 files) - Task 6: docusaurus-plugin-typedoc for 18 SDK entry points - Task 7: Sidebar with SDK Reference + API Reference categories - Task 8: @easyops-cn/docusaurus-search-local plugin Fixes applied during verification: - TypeDoc output path corrected to docs/sdk (was sdk/) - mdxOptions format:detect to treat .md as plain markdown - Footer cleanup regex broadened to catch all variations - Stale tutorial scaffold docs removed --- .../cluster/AdmissionregistrationApi.md | 62 + .../cluster/AdmissionregistrationV1Api.md | 3767 ++ .../AdmissionregistrationV1alpha1Api.md | 1750 + .../AdmissionregistrationV1beta1Api.md | 1750 + .../api-reference/cluster/ApiextensionsApi.md | 62 + .../cluster/ApiextensionsV1Api.md | 1484 + .../cluster/ApiregistrationApi.md | 62 + .../cluster/ApiregistrationV1Api.md | 1031 + .../api-reference/cluster/SchedulingApi.md | 62 + .../api-reference/cluster/SchedulingV1Api.md | 719 + .../cluster/SchedulingV1alpha1Api.md | 853 + .../api-reference/cluster/_category_.json | 4 + .../configuration-storage/CoordinationApi.md | 62 + .../CoordinationV1Api.md | 835 + .../CoordinationV1alpha2Api.md | 833 + .../CoordinationV1beta1Api.md | 833 + .../configuration-storage/PolicyApi.md | 62 + .../configuration-storage/PolicyV1Api.md | 1191 + .../configuration-storage/StorageApi.md | 62 + .../configuration-storage/StorageV1Api.md | 5308 +++ .../StorageV1beta1Api.md | 719 + .../StoragemigrationApi.md | 62 + .../StoragemigrationV1beta1Api.md | 1016 + .../configuration-storage/_category_.json | 4 + .../api-reference/core-resources/CoreApi.md | 62 + .../api-reference/core-resources/CoreV1Api.md | 39221 ++++++++++++++++ .../api-reference/core-resources/EventsApi.md | 62 + .../core-resources/EventsV1Api.md | 889 + .../api-reference/core-resources/NodeApi.md | 62 + .../api-reference/core-resources/NodeV1Api.md | 751 + .../core-resources/_category_.json | 4 + .../api-reference/networking/DiscoveryApi.md | 62 + .../networking/DiscoveryV1Api.md | 913 + .../api-reference/networking/NetworkingApi.md | 62 + .../networking/NetworkingV1Api.md | 4552 ++ .../networking/NetworkingV1beta1Api.md | 1675 + .../api-reference/networking/_category_.json | 4 + website/docs/api-reference/other/ApisApi.md | 62 + .../api-reference/other/AutoscalingApi.md | 62 + .../api-reference/other/AutoscalingV1Api.md | 1125 + .../api-reference/other/AutoscalingV2Api.md | 1833 + .../api-reference/other/CustomObjectsApi.md | 2234 + .../other/FlowcontrolApiserverApi.md | 62 + .../other/FlowcontrolApiserverV1Api.md | 2147 + .../other/InternalApiserverApi.md | 62 + .../other/InternalApiserverV1alpha1Api.md | 1037 + website/docs/api-reference/other/LogsApi.md | 111 + website/docs/api-reference/other/OpenidApi.md | 62 + .../docs/api-reference/other/ResourceApi.md | 62 + .../docs/api-reference/other/ResourceV1Api.md | 4243 ++ .../other/ResourceV1alpha3Api.md | 1034 + .../api-reference/other/ResourceV1beta1Api.md | 4237 ++ .../api-reference/other/ResourceV1beta2Api.md | 4243 ++ .../docs/api-reference/other/VersionApi.md | 62 + .../docs/api-reference/other/WellKnownApi.md | 62 + .../docs/api-reference/other/_category_.json | 4 + .../security/AuthenticationApi.md | 62 + .../security/AuthenticationV1Api.md | 329 + .../security/AuthorizationApi.md | 62 + .../security/AuthorizationV1Api.md | 709 + .../api-reference/security/CertificatesApi.md | 62 + .../security/CertificatesV1Api.md | 1331 + .../security/CertificatesV1alpha1Api.md | 719 + .../security/CertificatesV1beta1Api.md | 1824 + .../security/RbacAuthorizationApi.md | 62 + .../security/RbacAuthorizationV1Api.md | 3034 ++ .../api-reference/security/_category_.json | 4 + .../docs/api-reference/workloads/AppsApi.md | 62 + .../docs/api-reference/workloads/AppsV1Api.md | 28122 +++++++++++ .../docs/api-reference/workloads/BatchApi.md | 62 + .../api-reference/workloads/BatchV1Api.md | 13489 ++++++ .../api-reference/workloads/_category_.json | 4 + website/docs/sdk/attach/classes/Attach.md | 75 + website/docs/sdk/attach/index.md | 5 + website/docs/sdk/cache/classes/ListWatch.md | 248 + .../sdk/cache/functions/addOrUpdateObject.md | 33 + .../sdk/cache/functions/cacheMapFromList.md | 21 + .../docs/sdk/cache/functions/deleteItems.md | 29 + .../docs/sdk/cache/functions/deleteObject.md | 29 + website/docs/sdk/cache/index.md | 20 + .../docs/sdk/cache/interfaces/ObjectCache.md | 49 + .../docs/sdk/cache/type-aliases/CacheMap.md | 11 + website/docs/sdk/config/classes/KubeConfig.md | 559 + .../functions/bufferFromFileOrString.md | 19 + .../docs/sdk/config/functions/findHomeDir.md | 15 + .../docs/sdk/config/functions/findObject.md | 29 + .../sdk/config/functions/makeAbsolutePath.md | 19 + website/docs/sdk/config/index.md | 21 + website/docs/sdk/config/interfaces/ApiType.md | 3 + website/docs/sdk/config/interfaces/Named.md | 11 + .../sdk/config/type-aliases/ApiConstructor.md | 21 + .../config_types/functions/exportCluster.md | 15 + .../config_types/functions/exportContext.md | 15 + .../sdk/config_types/functions/exportUser.md | 15 + .../sdk/config_types/functions/newClusters.md | 19 + .../sdk/config_types/functions/newContexts.md | 19 + .../sdk/config_types/functions/newUsers.md | 19 + website/docs/sdk/config_types/index.md | 25 + .../sdk/config_types/interfaces/Cluster.md | 59 + .../config_types/interfaces/ConfigOptions.md | 11 + .../sdk/config_types/interfaces/Context.md | 35 + .../docs/sdk/config_types/interfaces/User.md | 91 + .../type-aliases/ActionOnInvalid.md | 5 + .../config_types/variables/ActionOnInvalid.md | 15 + website/docs/sdk/cp/classes/Cp.md | 127 + website/docs/sdk/cp/index.md | 5 + website/docs/sdk/exec/classes/Exec.md | 103 + website/docs/sdk/exec/index.md | 5 + website/docs/sdk/health/classes/Health.md | 65 + website/docs/sdk/health/index.md | 5 + website/docs/sdk/index.md | 22 + .../sdk/informer/functions/makeInformer.md | 33 + website/docs/sdk/informer/index.md | 31 + .../docs/sdk/informer/interfaces/Informer.md | 121 + website/docs/sdk/informer/type-aliases/ADD.md | 5 + .../docs/sdk/informer/type-aliases/CHANGE.md | 5 + .../docs/sdk/informer/type-aliases/CONNECT.md | 5 + .../docs/sdk/informer/type-aliases/DELETE.md | 5 + .../docs/sdk/informer/type-aliases/ERROR.md | 5 + .../informer/type-aliases/ErrorCallback.md | 15 + .../sdk/informer/type-aliases/ListCallback.md | 25 + .../sdk/informer/type-aliases/ListPromise.md | 15 + .../informer/type-aliases/ObjectCallback.md | 21 + .../docs/sdk/informer/type-aliases/UPDATE.md | 5 + website/docs/sdk/informer/variables/ADD.md | 5 + website/docs/sdk/informer/variables/CHANGE.md | 5 + .../docs/sdk/informer/variables/CONNECT.md | 5 + website/docs/sdk/informer/variables/DELETE.md | 5 + website/docs/sdk/informer/variables/ERROR.md | 5 + website/docs/sdk/informer/variables/UPDATE.md | 5 + website/docs/sdk/log/classes/Log.md | 105 + .../log/functions/AddOptionsToSearchParams.md | 19 + website/docs/sdk/log/index.md | 13 + website/docs/sdk/log/interfaces/LogOptions.md | 88 + website/docs/sdk/metrics/classes/Metrics.md | 51 + website/docs/sdk/metrics/index.md | 14 + .../sdk/metrics/interfaces/ContainerMetric.md | 19 + .../docs/sdk/metrics/interfaces/NodeMetric.md | 47 + .../sdk/metrics/interfaces/NodeMetricsList.md | 39 + .../docs/sdk/metrics/interfaces/PodMetric.md | 51 + .../sdk/metrics/interfaces/PodMetricsList.md | 39 + website/docs/sdk/metrics/interfaces/Usage.md | 19 + .../functions/setHeaderMiddleware.md | 19 + .../middleware/functions/setHeaderOptions.md | 23 + website/docs/sdk/middleware/index.md | 6 + .../sdk/object/classes/KubernetesObjectApi.md | 466 + website/docs/sdk/object/index.md | 5 + website/docs/sdk/patch/index.md | 9 + .../sdk/patch/type-aliases/PatchStrategy.md | 12 + .../docs/sdk/patch/variables/PatchStrategy.md | 38 + .../sdk/portforward/classes/PortForward.md | 195 + website/docs/sdk/portforward/index.md | 5 + .../docs/sdk/top/classes/ContainerStatus.md | 53 + .../sdk/top/classes/CurrentResourceUsage.md | 53 + website/docs/sdk/top/classes/NodeStatus.md | 53 + website/docs/sdk/top/classes/PodStatus.md | 65 + website/docs/sdk/top/classes/ResourceUsage.md | 53 + website/docs/sdk/top/functions/topNodes.md | 15 + website/docs/sdk/top/functions/topPods.md | 23 + website/docs/sdk/top/index.md | 14 + website/docs/sdk/typedoc-sidebar.cjs | 4 + website/docs/sdk/types/classes/V1MicroTime.md | 141 + website/docs/sdk/types/index.md | 14 + .../types/interfaces/KubernetesListObject.md | 41 + .../sdk/types/interfaces/KubernetesObject.md | 27 + .../sdk/types/type-aliases/IntOrString.md | 5 + website/docs/sdk/watch/classes/Watch.md | 67 + website/docs/sdk/watch/index.md | 5 + website/docs/sdk/yaml/functions/dumpYaml.md | 27 + .../docs/sdk/yaml/functions/loadAllYaml.md | 27 + website/docs/sdk/yaml/functions/loadYaml.md | 33 + website/docs/sdk/yaml/index.md | 7 + website/docs/tutorial-basics/_category_.json | 8 - .../docs/tutorial-basics/congratulations.md | 23 - .../tutorial-basics/create-a-blog-post.md | 34 - .../docs/tutorial-basics/create-a-document.md | 57 - website/docs/tutorial-basics/create-a-page.md | 43 - .../docs/tutorial-basics/deploy-your-site.md | 31 - .../tutorial-basics/markdown-features.mdx | 152 - website/docs/tutorial-extras/_category_.json | 7 - .../img/docsVersionDropdown.png | Bin 25427 -> 0 bytes .../tutorial-extras/img/localeDropdown.png | Bin 27841 -> 0 bytes .../tutorial-extras/manage-docs-versions.md | 55 - .../tutorial-extras/translate-your-site.md | 88 - website/docusaurus.config.ts | 80 +- website/package-lock.json | 778 + website/package.json | 4 + website/scripts/transform-gen-docs.mjs | 336 + website/sidebars.ts | 108 +- 189 files changed, 149077 insertions(+), 542 deletions(-) create mode 100644 website/docs/api-reference/cluster/AdmissionregistrationApi.md create mode 100644 website/docs/api-reference/cluster/AdmissionregistrationV1Api.md create mode 100644 website/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api.md create mode 100644 website/docs/api-reference/cluster/AdmissionregistrationV1beta1Api.md create mode 100644 website/docs/api-reference/cluster/ApiextensionsApi.md create mode 100644 website/docs/api-reference/cluster/ApiextensionsV1Api.md create mode 100644 website/docs/api-reference/cluster/ApiregistrationApi.md create mode 100644 website/docs/api-reference/cluster/ApiregistrationV1Api.md create mode 100644 website/docs/api-reference/cluster/SchedulingApi.md create mode 100644 website/docs/api-reference/cluster/SchedulingV1Api.md create mode 100644 website/docs/api-reference/cluster/SchedulingV1alpha1Api.md create mode 100644 website/docs/api-reference/cluster/_category_.json create mode 100644 website/docs/api-reference/configuration-storage/CoordinationApi.md create mode 100644 website/docs/api-reference/configuration-storage/CoordinationV1Api.md create mode 100644 website/docs/api-reference/configuration-storage/CoordinationV1alpha2Api.md create mode 100644 website/docs/api-reference/configuration-storage/CoordinationV1beta1Api.md create mode 100644 website/docs/api-reference/configuration-storage/PolicyApi.md create mode 100644 website/docs/api-reference/configuration-storage/PolicyV1Api.md create mode 100644 website/docs/api-reference/configuration-storage/StorageApi.md create mode 100644 website/docs/api-reference/configuration-storage/StorageV1Api.md create mode 100644 website/docs/api-reference/configuration-storage/StorageV1beta1Api.md create mode 100644 website/docs/api-reference/configuration-storage/StoragemigrationApi.md create mode 100644 website/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api.md create mode 100644 website/docs/api-reference/configuration-storage/_category_.json create mode 100644 website/docs/api-reference/core-resources/CoreApi.md create mode 100644 website/docs/api-reference/core-resources/CoreV1Api.md create mode 100644 website/docs/api-reference/core-resources/EventsApi.md create mode 100644 website/docs/api-reference/core-resources/EventsV1Api.md create mode 100644 website/docs/api-reference/core-resources/NodeApi.md create mode 100644 website/docs/api-reference/core-resources/NodeV1Api.md create mode 100644 website/docs/api-reference/core-resources/_category_.json create mode 100644 website/docs/api-reference/networking/DiscoveryApi.md create mode 100644 website/docs/api-reference/networking/DiscoveryV1Api.md create mode 100644 website/docs/api-reference/networking/NetworkingApi.md create mode 100644 website/docs/api-reference/networking/NetworkingV1Api.md create mode 100644 website/docs/api-reference/networking/NetworkingV1beta1Api.md create mode 100644 website/docs/api-reference/networking/_category_.json create mode 100644 website/docs/api-reference/other/ApisApi.md create mode 100644 website/docs/api-reference/other/AutoscalingApi.md create mode 100644 website/docs/api-reference/other/AutoscalingV1Api.md create mode 100644 website/docs/api-reference/other/AutoscalingV2Api.md create mode 100644 website/docs/api-reference/other/CustomObjectsApi.md create mode 100644 website/docs/api-reference/other/FlowcontrolApiserverApi.md create mode 100644 website/docs/api-reference/other/FlowcontrolApiserverV1Api.md create mode 100644 website/docs/api-reference/other/InternalApiserverApi.md create mode 100644 website/docs/api-reference/other/InternalApiserverV1alpha1Api.md create mode 100644 website/docs/api-reference/other/LogsApi.md create mode 100644 website/docs/api-reference/other/OpenidApi.md create mode 100644 website/docs/api-reference/other/ResourceApi.md create mode 100644 website/docs/api-reference/other/ResourceV1Api.md create mode 100644 website/docs/api-reference/other/ResourceV1alpha3Api.md create mode 100644 website/docs/api-reference/other/ResourceV1beta1Api.md create mode 100644 website/docs/api-reference/other/ResourceV1beta2Api.md create mode 100644 website/docs/api-reference/other/VersionApi.md create mode 100644 website/docs/api-reference/other/WellKnownApi.md create mode 100644 website/docs/api-reference/other/_category_.json create mode 100644 website/docs/api-reference/security/AuthenticationApi.md create mode 100644 website/docs/api-reference/security/AuthenticationV1Api.md create mode 100644 website/docs/api-reference/security/AuthorizationApi.md create mode 100644 website/docs/api-reference/security/AuthorizationV1Api.md create mode 100644 website/docs/api-reference/security/CertificatesApi.md create mode 100644 website/docs/api-reference/security/CertificatesV1Api.md create mode 100644 website/docs/api-reference/security/CertificatesV1alpha1Api.md create mode 100644 website/docs/api-reference/security/CertificatesV1beta1Api.md create mode 100644 website/docs/api-reference/security/RbacAuthorizationApi.md create mode 100644 website/docs/api-reference/security/RbacAuthorizationV1Api.md create mode 100644 website/docs/api-reference/security/_category_.json create mode 100644 website/docs/api-reference/workloads/AppsApi.md create mode 100644 website/docs/api-reference/workloads/AppsV1Api.md create mode 100644 website/docs/api-reference/workloads/BatchApi.md create mode 100644 website/docs/api-reference/workloads/BatchV1Api.md create mode 100644 website/docs/api-reference/workloads/_category_.json create mode 100644 website/docs/sdk/attach/classes/Attach.md create mode 100644 website/docs/sdk/attach/index.md create mode 100644 website/docs/sdk/cache/classes/ListWatch.md create mode 100644 website/docs/sdk/cache/functions/addOrUpdateObject.md create mode 100644 website/docs/sdk/cache/functions/cacheMapFromList.md create mode 100644 website/docs/sdk/cache/functions/deleteItems.md create mode 100644 website/docs/sdk/cache/functions/deleteObject.md create mode 100644 website/docs/sdk/cache/index.md create mode 100644 website/docs/sdk/cache/interfaces/ObjectCache.md create mode 100644 website/docs/sdk/cache/type-aliases/CacheMap.md create mode 100644 website/docs/sdk/config/classes/KubeConfig.md create mode 100644 website/docs/sdk/config/functions/bufferFromFileOrString.md create mode 100644 website/docs/sdk/config/functions/findHomeDir.md create mode 100644 website/docs/sdk/config/functions/findObject.md create mode 100644 website/docs/sdk/config/functions/makeAbsolutePath.md create mode 100644 website/docs/sdk/config/index.md create mode 100644 website/docs/sdk/config/interfaces/ApiType.md create mode 100644 website/docs/sdk/config/interfaces/Named.md create mode 100644 website/docs/sdk/config/type-aliases/ApiConstructor.md create mode 100644 website/docs/sdk/config_types/functions/exportCluster.md create mode 100644 website/docs/sdk/config_types/functions/exportContext.md create mode 100644 website/docs/sdk/config_types/functions/exportUser.md create mode 100644 website/docs/sdk/config_types/functions/newClusters.md create mode 100644 website/docs/sdk/config_types/functions/newContexts.md create mode 100644 website/docs/sdk/config_types/functions/newUsers.md create mode 100644 website/docs/sdk/config_types/index.md create mode 100644 website/docs/sdk/config_types/interfaces/Cluster.md create mode 100644 website/docs/sdk/config_types/interfaces/ConfigOptions.md create mode 100644 website/docs/sdk/config_types/interfaces/Context.md create mode 100644 website/docs/sdk/config_types/interfaces/User.md create mode 100644 website/docs/sdk/config_types/type-aliases/ActionOnInvalid.md create mode 100644 website/docs/sdk/config_types/variables/ActionOnInvalid.md create mode 100644 website/docs/sdk/cp/classes/Cp.md create mode 100644 website/docs/sdk/cp/index.md create mode 100644 website/docs/sdk/exec/classes/Exec.md create mode 100644 website/docs/sdk/exec/index.md create mode 100644 website/docs/sdk/health/classes/Health.md create mode 100644 website/docs/sdk/health/index.md create mode 100644 website/docs/sdk/index.md create mode 100644 website/docs/sdk/informer/functions/makeInformer.md create mode 100644 website/docs/sdk/informer/index.md create mode 100644 website/docs/sdk/informer/interfaces/Informer.md create mode 100644 website/docs/sdk/informer/type-aliases/ADD.md create mode 100644 website/docs/sdk/informer/type-aliases/CHANGE.md create mode 100644 website/docs/sdk/informer/type-aliases/CONNECT.md create mode 100644 website/docs/sdk/informer/type-aliases/DELETE.md create mode 100644 website/docs/sdk/informer/type-aliases/ERROR.md create mode 100644 website/docs/sdk/informer/type-aliases/ErrorCallback.md create mode 100644 website/docs/sdk/informer/type-aliases/ListCallback.md create mode 100644 website/docs/sdk/informer/type-aliases/ListPromise.md create mode 100644 website/docs/sdk/informer/type-aliases/ObjectCallback.md create mode 100644 website/docs/sdk/informer/type-aliases/UPDATE.md create mode 100644 website/docs/sdk/informer/variables/ADD.md create mode 100644 website/docs/sdk/informer/variables/CHANGE.md create mode 100644 website/docs/sdk/informer/variables/CONNECT.md create mode 100644 website/docs/sdk/informer/variables/DELETE.md create mode 100644 website/docs/sdk/informer/variables/ERROR.md create mode 100644 website/docs/sdk/informer/variables/UPDATE.md create mode 100644 website/docs/sdk/log/classes/Log.md create mode 100644 website/docs/sdk/log/functions/AddOptionsToSearchParams.md create mode 100644 website/docs/sdk/log/index.md create mode 100644 website/docs/sdk/log/interfaces/LogOptions.md create mode 100644 website/docs/sdk/metrics/classes/Metrics.md create mode 100644 website/docs/sdk/metrics/index.md create mode 100644 website/docs/sdk/metrics/interfaces/ContainerMetric.md create mode 100644 website/docs/sdk/metrics/interfaces/NodeMetric.md create mode 100644 website/docs/sdk/metrics/interfaces/NodeMetricsList.md create mode 100644 website/docs/sdk/metrics/interfaces/PodMetric.md create mode 100644 website/docs/sdk/metrics/interfaces/PodMetricsList.md create mode 100644 website/docs/sdk/metrics/interfaces/Usage.md create mode 100644 website/docs/sdk/middleware/functions/setHeaderMiddleware.md create mode 100644 website/docs/sdk/middleware/functions/setHeaderOptions.md create mode 100644 website/docs/sdk/middleware/index.md create mode 100644 website/docs/sdk/object/classes/KubernetesObjectApi.md create mode 100644 website/docs/sdk/object/index.md create mode 100644 website/docs/sdk/patch/index.md create mode 100644 website/docs/sdk/patch/type-aliases/PatchStrategy.md create mode 100644 website/docs/sdk/patch/variables/PatchStrategy.md create mode 100644 website/docs/sdk/portforward/classes/PortForward.md create mode 100644 website/docs/sdk/portforward/index.md create mode 100644 website/docs/sdk/top/classes/ContainerStatus.md create mode 100644 website/docs/sdk/top/classes/CurrentResourceUsage.md create mode 100644 website/docs/sdk/top/classes/NodeStatus.md create mode 100644 website/docs/sdk/top/classes/PodStatus.md create mode 100644 website/docs/sdk/top/classes/ResourceUsage.md create mode 100644 website/docs/sdk/top/functions/topNodes.md create mode 100644 website/docs/sdk/top/functions/topPods.md create mode 100644 website/docs/sdk/top/index.md create mode 100644 website/docs/sdk/typedoc-sidebar.cjs create mode 100644 website/docs/sdk/types/classes/V1MicroTime.md create mode 100644 website/docs/sdk/types/index.md create mode 100644 website/docs/sdk/types/interfaces/KubernetesListObject.md create mode 100644 website/docs/sdk/types/interfaces/KubernetesObject.md create mode 100644 website/docs/sdk/types/type-aliases/IntOrString.md create mode 100644 website/docs/sdk/watch/classes/Watch.md create mode 100644 website/docs/sdk/watch/index.md create mode 100644 website/docs/sdk/yaml/functions/dumpYaml.md create mode 100644 website/docs/sdk/yaml/functions/loadAllYaml.md create mode 100644 website/docs/sdk/yaml/functions/loadYaml.md create mode 100644 website/docs/sdk/yaml/index.md delete mode 100644 website/docs/tutorial-basics/_category_.json delete mode 100644 website/docs/tutorial-basics/congratulations.md delete mode 100644 website/docs/tutorial-basics/create-a-blog-post.md delete mode 100644 website/docs/tutorial-basics/create-a-document.md delete mode 100644 website/docs/tutorial-basics/create-a-page.md delete mode 100644 website/docs/tutorial-basics/deploy-your-site.md delete mode 100644 website/docs/tutorial-basics/markdown-features.mdx delete mode 100644 website/docs/tutorial-extras/_category_.json delete mode 100644 website/docs/tutorial-extras/img/docsVersionDropdown.png delete mode 100644 website/docs/tutorial-extras/img/localeDropdown.png delete mode 100644 website/docs/tutorial-extras/manage-docs-versions.md delete mode 100644 website/docs/tutorial-extras/translate-your-site.md create mode 100644 website/scripts/transform-gen-docs.mjs diff --git a/website/docs/api-reference/cluster/AdmissionregistrationApi.md b/website/docs/api-reference/cluster/AdmissionregistrationApi.md new file mode 100644 index 00000000000..7b767b754f2 --- /dev/null +++ b/website/docs/api-reference/cluster/AdmissionregistrationApi.md @@ -0,0 +1,62 @@ +--- +id: AdmissionregistrationApi +title: AdmissionregistrationApi +sidebar_label: AdmissionregistrationApi +sidebar_position: 1 +--- +# AdmissionregistrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/cluster/AdmissionregistrationApi#getAPIGroup) | **GET** /apis/admissionregistration.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/AdmissionregistrationV1Api.md b/website/docs/api-reference/cluster/AdmissionregistrationV1Api.md new file mode 100644 index 00000000000..998daa88cab --- /dev/null +++ b/website/docs/api-reference/cluster/AdmissionregistrationV1Api.md @@ -0,0 +1,3767 @@ +--- +id: AdmissionregistrationV1Api +title: AdmissionregistrationV1Api +sidebar_label: AdmissionregistrationV1Api +sidebar_position: 3 +--- +# AdmissionregistrationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createMutatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**createValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**createValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**createValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**deleteCollectionMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**deleteCollectionValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**deleteCollectionValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**deleteCollectionValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**deleteMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**deleteValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**deleteValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**deleteValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1/ | +[**listMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**listValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**listValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**listValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**patchMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchMutatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**patchValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**patchValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**patchValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicyStatus) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**patchValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**readMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**readValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**readValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**readValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicyStatus) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**readValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**replaceMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceMutatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**replaceValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**replaceValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**replaceValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicyStatus) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**replaceValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | + +### createMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfiguration createMutatingWebhookConfiguration(body) + +create a MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + reinvocationPolicy: "reinvocationPolicy_example", + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1MutatingWebhookConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicy createValidatingAdmissionPolicy(body) + +create a ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBinding createValidatingAdmissionPolicyBinding(body) + +create a ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + validationActions: [ + "validationActions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfiguration createValidatingWebhookConfiguration(body) + +create a ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingWebhookConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingWebhookConfiguration + + + +> V1Status deleteCollectionMutatingWebhookConfiguration() + +delete collection of MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionValidatingAdmissionPolicy + + + +> V1Status deleteCollectionValidatingAdmissionPolicy() + +delete collection of ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionValidatingAdmissionPolicyBinding + + + +> V1Status deleteCollectionValidatingAdmissionPolicyBinding() + +delete collection of ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionValidatingWebhookConfiguration + + + +> V1Status deleteCollectionValidatingWebhookConfiguration() + +delete collection of ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteMutatingWebhookConfiguration + + + +> V1Status deleteMutatingWebhookConfiguration() + +delete a MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteValidatingAdmissionPolicy + + + +> V1Status deleteValidatingAdmissionPolicy() + +delete a ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteValidatingAdmissionPolicyBinding + + + +> V1Status deleteValidatingAdmissionPolicyBinding() + +delete a ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteValidatingWebhookConfiguration + + + +> V1Status deleteValidatingWebhookConfiguration() + +delete a ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfigurationList listMutatingWebhookConfiguration() + +list or watch objects of kind MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfigurationList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicyList listValidatingAdmissionPolicy() + +list or watch objects of kind ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBindingList listValidatingAdmissionPolicyBinding() + +list or watch objects of kind ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfigurationList listValidatingWebhookConfiguration() + +list or watch objects of kind ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfigurationList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfiguration patchMutatingWebhookConfiguration(body) + +partially update the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicy(body) + +partially update the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBinding patchValidatingAdmissionPolicyBinding(body) + +partially update the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchValidatingAdmissionPolicyStatus + + + +> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicyStatus(body) + +partially update status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfiguration patchValidatingWebhookConfiguration(body) + +partially update the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfiguration readMutatingWebhookConfiguration() + +read the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicy() + +read the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBinding readValidatingAdmissionPolicyBinding() + +read the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readValidatingAdmissionPolicyStatus + + + +> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicyStatus() + +read status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfiguration readValidatingWebhookConfiguration() + +read the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfiguration replaceMutatingWebhookConfiguration(body) + +replace the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + reinvocationPolicy: "reinvocationPolicy_example", + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1MutatingWebhookConfiguration**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicy(body) + +replace the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBinding replaceValidatingAdmissionPolicyBinding(body) + +replace the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + validationActions: [ + "validationActions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceValidatingAdmissionPolicyStatus + + + +> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicyStatus(body) + +replace status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfiguration replaceValidatingWebhookConfiguration(body) + +replace the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingWebhookConfiguration**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api.md b/website/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api.md new file mode 100644 index 00000000000..353f1bf6d99 --- /dev/null +++ b/website/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api.md @@ -0,0 +1,1750 @@ +--- +id: AdmissionregistrationV1alpha1Api +title: AdmissionregistrationV1alpha1Api +sidebar_label: AdmissionregistrationV1alpha1Api +sidebar_position: 2 +--- +# AdmissionregistrationV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**createMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**deleteCollectionMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**deleteCollectionMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**deleteMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**deleteMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/ | +[**listMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**listMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**patchMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**patchMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**readMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**readMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**replaceMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**replaceMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | + +### createMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) + +create a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) + +create a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingAdmissionPolicy + + + +> V1Status deleteCollectionMutatingAdmissionPolicy() + +delete collection of MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingAdmissionPolicyBinding + + + +> V1Status deleteCollectionMutatingAdmissionPolicyBinding() + +delete collection of MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteMutatingAdmissionPolicy + + + +> V1Status deleteMutatingAdmissionPolicy() + +delete a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteMutatingAdmissionPolicyBinding + + + +> V1Status deleteMutatingAdmissionPolicyBinding() + +delete a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() + +list or watch objects of kind MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() + +list or watch objects of kind MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) + +partially update the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) + +partially update the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicy readMutatingAdmissionPolicy() + +read the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() + +read the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) + +replace the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicy**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) + +replace the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/AdmissionregistrationV1beta1Api.md b/website/docs/api-reference/cluster/AdmissionregistrationV1beta1Api.md new file mode 100644 index 00000000000..e27b1f8e351 --- /dev/null +++ b/website/docs/api-reference/cluster/AdmissionregistrationV1beta1Api.md @@ -0,0 +1,1750 @@ +--- +id: AdmissionregistrationV1beta1Api +title: AdmissionregistrationV1beta1Api +sidebar_label: AdmissionregistrationV1beta1Api +sidebar_position: 4 +--- +# AdmissionregistrationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**createMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**deleteCollectionMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**deleteCollectionMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**deleteMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**deleteMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1beta1/ | +[**listMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**listMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**patchMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**patchMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**readMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**readMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**replaceMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**replaceMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | + +### createMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) + +create a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) + +create a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingAdmissionPolicy + + + +> V1Status deleteCollectionMutatingAdmissionPolicy() + +delete collection of MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingAdmissionPolicyBinding + + + +> V1Status deleteCollectionMutatingAdmissionPolicyBinding() + +delete collection of MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteMutatingAdmissionPolicy + + + +> V1Status deleteMutatingAdmissionPolicy() + +delete a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteMutatingAdmissionPolicyBinding + + + +> V1Status deleteMutatingAdmissionPolicyBinding() + +delete a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() + +list or watch objects of kind MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() + +list or watch objects of kind MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) + +partially update the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) + +partially update the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicy readMutatingAdmissionPolicy() + +read the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() + +read the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) + +replace the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicy**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) + +replace the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/ApiextensionsApi.md b/website/docs/api-reference/cluster/ApiextensionsApi.md new file mode 100644 index 00000000000..ea5d8022ad9 --- /dev/null +++ b/website/docs/api-reference/cluster/ApiextensionsApi.md @@ -0,0 +1,62 @@ +--- +id: ApiextensionsApi +title: ApiextensionsApi +sidebar_label: ApiextensionsApi +sidebar_position: 5 +--- +# ApiextensionsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/cluster/ApiextensionsApi#getAPIGroup) | **GET** /apis/apiextensions.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ApiextensionsApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/ApiextensionsV1Api.md b/website/docs/api-reference/cluster/ApiextensionsV1Api.md new file mode 100644 index 00000000000..bd87829b480 --- /dev/null +++ b/website/docs/api-reference/cluster/ApiextensionsV1Api.md @@ -0,0 +1,1484 @@ +--- +id: ApiextensionsV1Api +title: ApiextensionsV1Api +sidebar_label: ApiextensionsV1Api +sidebar_position: 6 +--- +# ApiextensionsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#createCustomResourceDefinition) | **POST** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**deleteCollectionCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#deleteCollectionCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**deleteCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#deleteCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**getAPIResources**](/docs/api-reference/cluster/ApiextensionsV1Api#getAPIResources) | **GET** /apis/apiextensions.k8s.io/v1/ | +[**listCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#listCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**patchCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#patchCustomResourceDefinition) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**patchCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#patchCustomResourceDefinitionStatus) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | +[**readCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#readCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**readCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#readCustomResourceDefinitionStatus) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | +[**replaceCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#replaceCustomResourceDefinition) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**replaceCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#replaceCustomResourceDefinitionStatus) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | + +### createCustomResourceDefinition + + + +> V1CustomResourceDefinition createCustomResourceDefinition(body) + +create a CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiCreateCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiCreateCustomResourceDefinitionRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionCustomResourceDefinition + + + +> V1Status deleteCollectionCustomResourceDefinition() + +delete collection of CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCustomResourceDefinition + + + +> V1Status deleteCustomResourceDefinition() + +delete a CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCustomResourceDefinition + + + +> V1CustomResourceDefinitionList listCustomResourceDefinition() + +list or watch objects of kind CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiListCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiListCustomResourceDefinitionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinitionList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchCustomResourceDefinition + + + +> V1CustomResourceDefinition patchCustomResourceDefinition(body) + +partially update the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiPatchCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiPatchCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchCustomResourceDefinitionStatus + + + +> V1CustomResourceDefinition patchCustomResourceDefinitionStatus(body) + +partially update status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readCustomResourceDefinition + + + +> V1CustomResourceDefinition readCustomResourceDefinition() + +read the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiReadCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReadCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readCustomResourceDefinitionStatus + + + +> V1CustomResourceDefinition readCustomResourceDefinitionStatus() + +read status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceCustomResourceDefinition + + + +> V1CustomResourceDefinition replaceCustomResourceDefinition(body) + +replace the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceCustomResourceDefinitionStatus + + + +> V1CustomResourceDefinition replaceCustomResourceDefinitionStatus(body) + +replace status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/ApiregistrationApi.md b/website/docs/api-reference/cluster/ApiregistrationApi.md new file mode 100644 index 00000000000..d129ebb0855 --- /dev/null +++ b/website/docs/api-reference/cluster/ApiregistrationApi.md @@ -0,0 +1,62 @@ +--- +id: ApiregistrationApi +title: ApiregistrationApi +sidebar_label: ApiregistrationApi +sidebar_position: 7 +--- +# ApiregistrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/cluster/ApiregistrationApi#getAPIGroup) | **GET** /apis/apiregistration.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ApiregistrationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/ApiregistrationV1Api.md b/website/docs/api-reference/cluster/ApiregistrationV1Api.md new file mode 100644 index 00000000000..962919a679a --- /dev/null +++ b/website/docs/api-reference/cluster/ApiregistrationV1Api.md @@ -0,0 +1,1031 @@ +--- +id: ApiregistrationV1Api +title: ApiregistrationV1Api +sidebar_label: ApiregistrationV1Api +sidebar_position: 8 +--- +# ApiregistrationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#createAPIService) | **POST** /apis/apiregistration.k8s.io/v1/apiservices | +[**deleteAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#deleteAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**deleteCollectionAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#deleteCollectionAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices | +[**getAPIResources**](/docs/api-reference/cluster/ApiregistrationV1Api#getAPIResources) | **GET** /apis/apiregistration.k8s.io/v1/ | +[**listAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#listAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices | +[**patchAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#patchAPIService) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**patchAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#patchAPIServiceStatus) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | +[**readAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#readAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**readAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#readAPIServiceStatus) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | +[**replaceAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#replaceAPIService) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**replaceAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#replaceAPIServiceStatus) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | + +### createAPIService + + + +> V1APIService createAPIService(body) + +create an APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiCreateAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiCreateAPIServiceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteAPIService + + + +> V1Status deleteAPIService() + +delete an APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiDeleteAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiDeleteAPIServiceRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionAPIService + + + +> V1Status deleteCollectionAPIService() + +delete collection of APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiDeleteCollectionAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiDeleteCollectionAPIServiceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listAPIService + + + +> V1APIServiceList listAPIService() + +list or watch objects of kind APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiListAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiListAPIServiceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1APIServiceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchAPIService + + + +> V1APIService patchAPIService(body) + +partially update the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiPatchAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiPatchAPIServiceRequest = { + // name of the APIService + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchAPIServiceStatus + + + +> V1APIService patchAPIServiceStatus(body) + +partially update status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiPatchAPIServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiPatchAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readAPIService + + + +> V1APIService readAPIService() + +read the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiReadAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReadAPIServiceRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readAPIServiceStatus + + + +> V1APIService readAPIServiceStatus() + +read status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiReadAPIServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReadAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceAPIService + + + +> V1APIService replaceAPIService(body) + +replace the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiReplaceAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReplaceAPIServiceRequest = { + // name of the APIService + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceAPIServiceStatus + + + +> V1APIService replaceAPIServiceStatus(body) + +replace status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiReplaceAPIServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReplaceAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/SchedulingApi.md b/website/docs/api-reference/cluster/SchedulingApi.md new file mode 100644 index 00000000000..574a8c7d9b8 --- /dev/null +++ b/website/docs/api-reference/cluster/SchedulingApi.md @@ -0,0 +1,62 @@ +--- +id: SchedulingApi +title: SchedulingApi +sidebar_label: SchedulingApi +sidebar_position: 9 +--- +# SchedulingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/cluster/SchedulingApi#getAPIGroup) | **GET** /apis/scheduling.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, SchedulingApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/SchedulingV1Api.md b/website/docs/api-reference/cluster/SchedulingV1Api.md new file mode 100644 index 00000000000..2bb8614b6f4 --- /dev/null +++ b/website/docs/api-reference/cluster/SchedulingV1Api.md @@ -0,0 +1,719 @@ +--- +id: SchedulingV1Api +title: SchedulingV1Api +sidebar_label: SchedulingV1Api +sidebar_position: 11 +--- +# SchedulingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#createPriorityClass) | **POST** /apis/scheduling.k8s.io/v1/priorityclasses | +[**deleteCollectionPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#deleteCollectionPriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses | +[**deletePriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#deletePriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**getAPIResources**](/docs/api-reference/cluster/SchedulingV1Api#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1/ | +[**listPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#listPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses | +[**patchPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#patchPriorityClass) | **PATCH** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**readPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#readPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**replacePriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#replacePriorityClass) | **PUT** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | + +### createPriorityClass + + + +> V1PriorityClass createPriorityClass(body) + +create a PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiCreatePriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiCreatePriorityClassRequest = { + + body: { + apiVersion: "apiVersion_example", + description: "description_example", + globalDefault: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + preemptionPolicy: "preemptionPolicy_example", + value: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionPriorityClass + + + +> V1Status deleteCollectionPriorityClass() + +delete collection of PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiDeleteCollectionPriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiDeleteCollectionPriorityClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deletePriorityClass + + + +> V1Status deletePriorityClass() + +delete a PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiDeletePriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiDeletePriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPriorityClass + + + +> V1PriorityClassList listPriorityClass() + +list or watch objects of kind PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiListPriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiListPriorityClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PriorityClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchPriorityClass + + + +> V1PriorityClass patchPriorityClass(body) + +partially update the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiPatchPriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiPatchPriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PriorityClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readPriorityClass + + + +> V1PriorityClass readPriorityClass() + +read the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiReadPriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiReadPriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PriorityClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replacePriorityClass + + + +> V1PriorityClass replacePriorityClass(body) + +replace the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiReplacePriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiReplacePriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + description: "description_example", + globalDefault: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + preemptionPolicy: "preemptionPolicy_example", + value: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityClass**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/SchedulingV1alpha1Api.md b/website/docs/api-reference/cluster/SchedulingV1alpha1Api.md new file mode 100644 index 00000000000..73e5bfc18f5 --- /dev/null +++ b/website/docs/api-reference/cluster/SchedulingV1alpha1Api.md @@ -0,0 +1,853 @@ +--- +id: SchedulingV1alpha1Api +title: SchedulingV1alpha1Api +sidebar_label: SchedulingV1alpha1Api +sidebar_position: 10 +--- +# SchedulingV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#createNamespacedWorkload) | **POST** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**deleteCollectionNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#deleteCollectionNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**deleteNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#deleteNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**getAPIResources**](/docs/api-reference/cluster/SchedulingV1alpha1Api#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1alpha1/ | +[**listNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#listNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**listWorkloadForAllNamespaces**](/docs/api-reference/cluster/SchedulingV1alpha1Api#listWorkloadForAllNamespaces) | **GET** /apis/scheduling.k8s.io/v1alpha1/workloads | +[**patchNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#patchNamespacedWorkload) | **PATCH** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**readNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#readNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**replaceNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#replaceNamespacedWorkload) | **PUT** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | + +### createNamespacedWorkload + + + +> V1alpha1Workload createNamespacedWorkload(body) + +create a Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controllerRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + podGroups: [ + { + name: "name_example", + policy: { + basic: {}, + gang: { + minCount: 1, + }, + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1Workload**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1Workload + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedWorkload + + + +> V1Status deleteCollectionNamespacedWorkload() + +delete collection of Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedWorkload + + + +> V1Status deleteNamespacedWorkload() + +delete a Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedWorkload + + + +> V1alpha1WorkloadList listNamespacedWorkload() + +list or watch objects of kind Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiListNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiListNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1WorkloadList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listWorkloadForAllNamespaces + + + +> V1alpha1WorkloadList listWorkloadForAllNamespaces() + +list or watch objects of kind Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listWorkloadForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1WorkloadList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedWorkload + + + +> V1alpha1Workload patchNamespacedWorkload(body) + +partially update the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1Workload + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedWorkload + + + +> V1alpha1Workload readNamespacedWorkload() + +read the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiReadNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiReadNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1Workload + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedWorkload + + + +> V1alpha1Workload replaceNamespacedWorkload(body) + +replace the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controllerRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + podGroups: [ + { + name: "name_example", + policy: { + basic: {}, + gang: { + minCount: 1, + }, + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1Workload**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1Workload + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/cluster/_category_.json b/website/docs/api-reference/cluster/_category_.json new file mode 100644 index 00000000000..0cc46b9cf1e --- /dev/null +++ b/website/docs/api-reference/cluster/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Cluster", + "position": 6 +} diff --git a/website/docs/api-reference/configuration-storage/CoordinationApi.md b/website/docs/api-reference/configuration-storage/CoordinationApi.md new file mode 100644 index 00000000000..80b8df4938e --- /dev/null +++ b/website/docs/api-reference/configuration-storage/CoordinationApi.md @@ -0,0 +1,62 @@ +--- +id: CoordinationApi +title: CoordinationApi +sidebar_label: CoordinationApi +sidebar_position: 1 +--- +# CoordinationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/configuration-storage/CoordinationApi#getAPIGroup) | **GET** /apis/coordination.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, CoordinationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/CoordinationV1Api.md b/website/docs/api-reference/configuration-storage/CoordinationV1Api.md new file mode 100644 index 00000000000..9473e68ac7a --- /dev/null +++ b/website/docs/api-reference/configuration-storage/CoordinationV1Api.md @@ -0,0 +1,835 @@ +--- +id: CoordinationV1Api +title: CoordinationV1Api +sidebar_label: CoordinationV1Api +sidebar_position: 3 +--- +# CoordinationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#createNamespacedLease) | **POST** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**deleteCollectionNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#deleteCollectionNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**deleteNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#deleteNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1/ | +[**listLeaseForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1Api#listLeaseForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1/leases | +[**listNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#listNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**patchNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#patchNamespacedLease) | **PATCH** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**readNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#readNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**replaceNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#replaceNamespacedLease) | **PUT** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | + +### createNamespacedLease + + + +> V1Lease createNamespacedLease(body) + +create a Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiCreateNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiCreateNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + acquireTime: "acquireTime_example", + holderIdentity: "holderIdentity_example", + leaseDurationSeconds: 1, + leaseTransitions: 1, + preferredHolder: "preferredHolder_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Lease**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Lease + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedLease + + + +> V1Status deleteCollectionNamespacedLease() + +delete collection of Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedLease + + + +> V1Status deleteNamespacedLease() + +delete a Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiDeleteNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiDeleteNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listLeaseForAllNamespaces + + + +> V1LeaseList listLeaseForAllNamespaces() + +list or watch objects of kind Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiListLeaseForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiListLeaseForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1LeaseList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedLease + + + +> V1LeaseList listNamespacedLease() + +list or watch objects of kind Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiListNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiListNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1LeaseList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedLease + + + +> V1Lease patchNamespacedLease(body) + +partially update the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiPatchNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiPatchNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Lease + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedLease + + + +> V1Lease readNamespacedLease() + +read the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiReadNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiReadNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Lease + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedLease + + + +> V1Lease replaceNamespacedLease(body) + +replace the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiReplaceNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiReplaceNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + acquireTime: "acquireTime_example", + holderIdentity: "holderIdentity_example", + leaseDurationSeconds: 1, + leaseTransitions: 1, + preferredHolder: "preferredHolder_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Lease**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Lease + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/CoordinationV1alpha2Api.md b/website/docs/api-reference/configuration-storage/CoordinationV1alpha2Api.md new file mode 100644 index 00000000000..28670d08afe --- /dev/null +++ b/website/docs/api-reference/configuration-storage/CoordinationV1alpha2Api.md @@ -0,0 +1,833 @@ +--- +id: CoordinationV1alpha2Api +title: CoordinationV1alpha2Api +sidebar_label: CoordinationV1alpha2Api +sidebar_position: 2 +--- +# CoordinationV1alpha2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**deleteCollectionNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**deleteNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1alpha2/ | +[**listLeaseCandidateForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1alpha2/leasecandidates | +[**listNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**patchNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**readNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**replaceNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | + +### createNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidate createNamespacedLeaseCandidate(body) + +create a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha2LeaseCandidate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedLeaseCandidate + + + +> V1Status deleteCollectionNamespacedLeaseCandidate() + +delete collection of LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedLeaseCandidate + + + +> V1Status deleteNamespacedLeaseCandidate() + +delete a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listLeaseCandidateForAllNamespaces + + + +> V1alpha2LeaseCandidateList listLeaseCandidateForAllNamespaces() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidateList listNamespacedLeaseCandidate() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidate patchNamespacedLeaseCandidate(body) + +partially update the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidate readNamespacedLeaseCandidate() + +read the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidate replaceNamespacedLeaseCandidate(body) + +replace the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha2LeaseCandidate**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/CoordinationV1beta1Api.md b/website/docs/api-reference/configuration-storage/CoordinationV1beta1Api.md new file mode 100644 index 00000000000..ae939c61b48 --- /dev/null +++ b/website/docs/api-reference/configuration-storage/CoordinationV1beta1Api.md @@ -0,0 +1,833 @@ +--- +id: CoordinationV1beta1Api +title: CoordinationV1beta1Api +sidebar_label: CoordinationV1beta1Api +sidebar_position: 4 +--- +# CoordinationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**deleteCollectionNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**deleteNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1beta1/ | +[**listLeaseCandidateForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1beta1/leasecandidates | +[**listNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**patchNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**readNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**replaceNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | + +### createNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidate createNamespacedLeaseCandidate(body) + +create a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1LeaseCandidate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedLeaseCandidate + + + +> V1Status deleteCollectionNamespacedLeaseCandidate() + +delete collection of LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedLeaseCandidate + + + +> V1Status deleteNamespacedLeaseCandidate() + +delete a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listLeaseCandidateForAllNamespaces + + + +> V1beta1LeaseCandidateList listLeaseCandidateForAllNamespaces() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidateList listNamespacedLeaseCandidate() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidate patchNamespacedLeaseCandidate(body) + +partially update the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidate readNamespacedLeaseCandidate() + +read the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidate replaceNamespacedLeaseCandidate(body) + +replace the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1LeaseCandidate**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/PolicyApi.md b/website/docs/api-reference/configuration-storage/PolicyApi.md new file mode 100644 index 00000000000..3dc65d31ce0 --- /dev/null +++ b/website/docs/api-reference/configuration-storage/PolicyApi.md @@ -0,0 +1,62 @@ +--- +id: PolicyApi +title: PolicyApi +sidebar_label: PolicyApi +sidebar_position: 5 +--- +# PolicyApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/configuration-storage/PolicyApi#getAPIGroup) | **GET** /apis/policy/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, PolicyApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/PolicyV1Api.md b/website/docs/api-reference/configuration-storage/PolicyV1Api.md new file mode 100644 index 00000000000..57e052b9fb7 --- /dev/null +++ b/website/docs/api-reference/configuration-storage/PolicyV1Api.md @@ -0,0 +1,1191 @@ +--- +id: PolicyV1Api +title: PolicyV1Api +sidebar_label: PolicyV1Api +sidebar_position: 6 +--- +# PolicyV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#createNamespacedPodDisruptionBudget) | **POST** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**deleteCollectionNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#deleteCollectionNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**deleteNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#deleteNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/PolicyV1Api#getAPIResources) | **GET** /apis/policy/v1/ | +[**listNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#listNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**listPodDisruptionBudgetForAllNamespaces**](/docs/api-reference/configuration-storage/PolicyV1Api#listPodDisruptionBudgetForAllNamespaces) | **GET** /apis/policy/v1/poddisruptionbudgets | +[**patchNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#patchNamespacedPodDisruptionBudget) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**patchNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#patchNamespacedPodDisruptionBudgetStatus) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | +[**readNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#readNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**readNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#readNamespacedPodDisruptionBudgetStatus) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | +[**replaceNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#replaceNamespacedPodDisruptionBudget) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**replaceNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#replaceNamespacedPodDisruptionBudgetStatus) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | + +### createNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudget createNamespacedPodDisruptionBudget(body) + +create a PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPodDisruptionBudget + + + +> V1Status deleteCollectionNamespacedPodDisruptionBudget() + +delete collection of PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedPodDisruptionBudget + + + +> V1Status deleteNamespacedPodDisruptionBudget() + +delete a PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudgetList listNamespacedPodDisruptionBudget() + +list or watch objects of kind PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiListNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiListNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudgetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPodDisruptionBudgetForAllNamespaces + + + +> V1PodDisruptionBudgetList listPodDisruptionBudgetForAllNamespaces() + +list or watch objects of kind PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodDisruptionBudgetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudgetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudget patchNamespacedPodDisruptionBudget(body) + +partially update the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodDisruptionBudgetStatus + + + +> V1PodDisruptionBudget patchNamespacedPodDisruptionBudgetStatus(body) + +partially update status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudget readNamespacedPodDisruptionBudget() + +read the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodDisruptionBudgetStatus + + + +> V1PodDisruptionBudget readNamespacedPodDisruptionBudgetStatus() + +read status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudget(body) + +replace the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodDisruptionBudgetStatus + + + +> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudgetStatus(body) + +replace status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/StorageApi.md b/website/docs/api-reference/configuration-storage/StorageApi.md new file mode 100644 index 00000000000..e5460e8bc7e --- /dev/null +++ b/website/docs/api-reference/configuration-storage/StorageApi.md @@ -0,0 +1,62 @@ +--- +id: StorageApi +title: StorageApi +sidebar_label: StorageApi +sidebar_position: 7 +--- +# StorageApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/configuration-storage/StorageApi#getAPIGroup) | **GET** /apis/storage.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, StorageApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/StorageV1Api.md b/website/docs/api-reference/configuration-storage/StorageV1Api.md new file mode 100644 index 00000000000..5a7b8715d3c --- /dev/null +++ b/website/docs/api-reference/configuration-storage/StorageV1Api.md @@ -0,0 +1,5308 @@ +--- +id: StorageV1Api +title: StorageV1Api +sidebar_label: StorageV1Api +sidebar_position: 10 +--- +# StorageV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#createCSIDriver) | **POST** /apis/storage.k8s.io/v1/csidrivers | +[**createCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#createCSINode) | **POST** /apis/storage.k8s.io/v1/csinodes | +[**createNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#createNamespacedCSIStorageCapacity) | **POST** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**createStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#createStorageClass) | **POST** /apis/storage.k8s.io/v1/storageclasses | +[**createVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#createVolumeAttachment) | **POST** /apis/storage.k8s.io/v1/volumeattachments | +[**createVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**deleteCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**deleteCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes/{name} | +[**deleteCollectionCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers | +[**deleteCollectionCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes | +[**deleteCollectionNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**deleteCollectionStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses | +[**deleteCollectionVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments | +[**deleteCollectionVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**deleteNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#deleteNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**deleteStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**deleteVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#deleteVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**deleteVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/StorageV1Api#getAPIResources) | **GET** /apis/storage.k8s.io/v1/ | +[**listCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#listCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers | +[**listCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#listCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes | +[**listCSIStorageCapacityForAllNamespaces**](/docs/api-reference/configuration-storage/StorageV1Api#listCSIStorageCapacityForAllNamespaces) | **GET** /apis/storage.k8s.io/v1/csistoragecapacities | +[**listNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#listNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**listStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#listStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses | +[**listVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#listVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments | +[**listVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**patchCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#patchCSIDriver) | **PATCH** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**patchCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#patchCSINode) | **PATCH** /apis/storage.k8s.io/v1/csinodes/{name} | +[**patchNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#patchNamespacedCSIStorageCapacity) | **PATCH** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**patchStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#patchStorageClass) | **PATCH** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**patchVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttachment) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**patchVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttachmentStatus) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**patchVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**readCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#readCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**readCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#readCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes/{name} | +[**readNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#readNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**readStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#readStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**readVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**readVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttachmentStatus) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**readVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**replaceCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#replaceCSIDriver) | **PUT** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**replaceCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#replaceCSINode) | **PUT** /apis/storage.k8s.io/v1/csinodes/{name} | +[**replaceNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#replaceNamespacedCSIStorageCapacity) | **PUT** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**replaceStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#replaceStorageClass) | **PUT** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**replaceVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttachment) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**replaceVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttachmentStatus) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**replaceVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | + +### createCSIDriver + + + +> V1CSIDriver createCSIDriver(body) + +create a CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateCSIDriverRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attachRequired: true, + fsGroupPolicy: "fsGroupPolicy_example", + nodeAllocatableUpdatePeriodSeconds: 1, + podInfoOnMount: true, + requiresRepublish: true, + seLinuxMount: true, + serviceAccountTokenInSecrets: true, + storageCapacity: true, + tokenRequests: [ + { + audience: "audience_example", + expirationSeconds: 1, + }, + ], + volumeLifecycleModes: [ + "volumeLifecycleModes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIDriver**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createCSINode + + + +> V1CSINode createCSINode(body) + +create a CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateCSINodeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + drivers: [ + { + allocatable: { + count: 1, + }, + name: "name_example", + nodeID: "nodeID_example", + topologyKeys: [ + "topologyKeys_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSINode**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacity createNamespacedCSIStorageCapacity(body) + +create a CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + capacity: "capacity_example", + kind: "kind_example", + maximumVolumeSize: "maximumVolumeSize_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + nodeTopology: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIStorageCapacity**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacity + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createStorageClass + + + +> V1StorageClass createStorageClass(body) + +create a StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateStorageClassRequest = { + + body: { + allowVolumeExpansion: true, + allowedTopologies: [ + { + matchLabelExpressions: [ + { + key: "key_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + mountOptions: [ + "mountOptions_example", + ], + parameters: { + "key": "key_example", + }, + provisioner: "provisioner_example", + reclaimPolicy: "reclaimPolicy_example", + volumeBindingMode: "volumeBindingMode_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StorageClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createVolumeAttachment + + + +> V1VolumeAttachment createVolumeAttachment(body) + +create a VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateVolumeAttachmentRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createVolumeAttributesClass + + + +> V1VolumeAttributesClass createVolumeAttributesClass(body) + +create a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateVolumeAttributesClassRequest = { + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttributesClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCSIDriver + + + +> V1CSIDriver deleteCSIDriver() + +delete a CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCSINode + + + +> V1CSINode deleteCSINode() + +delete a CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCSINodeRequest = { + // name of the CSINode + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionCSIDriver + + + +> V1Status deleteCollectionCSIDriver() + +delete collection of CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionCSIDriverRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionCSINode + + + +> V1Status deleteCollectionCSINode() + +delete collection of CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionCSINodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedCSIStorageCapacity + + + +> V1Status deleteCollectionNamespacedCSIStorageCapacity() + +delete collection of CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionStorageClass + + + +> V1Status deleteCollectionStorageClass() + +delete collection of StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionStorageClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionVolumeAttachment + + + +> V1Status deleteCollectionVolumeAttachment() + +delete collection of VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionVolumeAttachmentRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionVolumeAttributesClass + + + +> V1Status deleteCollectionVolumeAttributesClass() + +delete collection of VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedCSIStorageCapacity + + + +> V1Status deleteNamespacedCSIStorageCapacity() + +delete a CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteStorageClass + + + +> V1StorageClass deleteStorageClass() + +delete a StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteStorageClassRequest = { + // name of the StorageClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteVolumeAttachment + + + +> V1VolumeAttachment deleteVolumeAttachment() + +delete a VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteVolumeAttributesClass + + + +> V1VolumeAttributesClass deleteVolumeAttributesClass() + +delete a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCSIDriver + + + +> V1CSIDriverList listCSIDriver() + +list or watch objects of kind CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSIDriverRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CSIDriverList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCSINode + + + +> V1CSINodeList listCSINode() + +list or watch objects of kind CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSINodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CSINodeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCSIStorageCapacityForAllNamespaces + + + +> V1CSIStorageCapacityList listCSIStorageCapacityForAllNamespaces() + +list or watch objects of kind CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSIStorageCapacityForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacityList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacityList listNamespacedCSIStorageCapacity() + +list or watch objects of kind CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacityList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listStorageClass + + + +> V1StorageClassList listStorageClass() + +list or watch objects of kind StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListStorageClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1StorageClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listVolumeAttachment + + + +> V1VolumeAttachmentList listVolumeAttachment() + +list or watch objects of kind VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListVolumeAttachmentRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachmentList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listVolumeAttributesClass + + + +> V1VolumeAttributesClassList listVolumeAttributesClass() + +list or watch objects of kind VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchCSIDriver + + + +> V1CSIDriver patchCSIDriver(body) + +partially update the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchCSINode + + + +> V1CSINode patchCSINode(body) + +partially update the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchCSINodeRequest = { + // name of the CSINode + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacity patchNamespacedCSIStorageCapacity(body) + +partially update the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacity + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchStorageClass + + + +> V1StorageClass patchStorageClass(body) + +partially update the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchStorageClassRequest = { + // name of the StorageClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchVolumeAttachment + + + +> V1VolumeAttachment patchVolumeAttachment(body) + +partially update the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchVolumeAttachmentStatus + + + +> V1VolumeAttachment patchVolumeAttachmentStatus(body) + +partially update status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchVolumeAttributesClass + + + +> V1VolumeAttributesClass patchVolumeAttributesClass(body) + +partially update the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readCSIDriver + + + +> V1CSIDriver readCSIDriver() + +read the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readCSINode + + + +> V1CSINode readCSINode() + +read the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadCSINodeRequest = { + // name of the CSINode + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacity readNamespacedCSIStorageCapacity() + +read the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacity + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readStorageClass + + + +> V1StorageClass readStorageClass() + +read the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadStorageClassRequest = { + // name of the StorageClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readVolumeAttachment + + + +> V1VolumeAttachment readVolumeAttachment() + +read the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readVolumeAttachmentStatus + + + +> V1VolumeAttachment readVolumeAttachmentStatus() + +read status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readVolumeAttributesClass + + + +> V1VolumeAttributesClass readVolumeAttributesClass() + +read the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceCSIDriver + + + +> V1CSIDriver replaceCSIDriver(body) + +replace the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attachRequired: true, + fsGroupPolicy: "fsGroupPolicy_example", + nodeAllocatableUpdatePeriodSeconds: 1, + podInfoOnMount: true, + requiresRepublish: true, + seLinuxMount: true, + serviceAccountTokenInSecrets: true, + storageCapacity: true, + tokenRequests: [ + { + audience: "audience_example", + expirationSeconds: 1, + }, + ], + volumeLifecycleModes: [ + "volumeLifecycleModes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIDriver**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceCSINode + + + +> V1CSINode replaceCSINode(body) + +replace the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceCSINodeRequest = { + // name of the CSINode + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + drivers: [ + { + allocatable: { + count: 1, + }, + name: "name_example", + nodeID: "nodeID_example", + topologyKeys: [ + "topologyKeys_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSINode**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacity replaceNamespacedCSIStorageCapacity(body) + +replace the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + capacity: "capacity_example", + kind: "kind_example", + maximumVolumeSize: "maximumVolumeSize_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + nodeTopology: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIStorageCapacity**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacity + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceStorageClass + + + +> V1StorageClass replaceStorageClass(body) + +replace the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceStorageClassRequest = { + // name of the StorageClass + name: "name_example", + + body: { + allowVolumeExpansion: true, + allowedTopologies: [ + { + matchLabelExpressions: [ + { + key: "key_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + mountOptions: [ + "mountOptions_example", + ], + parameters: { + "key": "key_example", + }, + provisioner: "provisioner_example", + reclaimPolicy: "reclaimPolicy_example", + volumeBindingMode: "volumeBindingMode_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StorageClass**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceVolumeAttachment + + + +> V1VolumeAttachment replaceVolumeAttachment(body) + +replace the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceVolumeAttachmentStatus + + + +> V1VolumeAttachment replaceVolumeAttachmentStatus(body) + +replace status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceVolumeAttributesClass + + + +> V1VolumeAttributesClass replaceVolumeAttributesClass(body) + +replace the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttributesClass**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/StorageV1beta1Api.md b/website/docs/api-reference/configuration-storage/StorageV1beta1Api.md new file mode 100644 index 00000000000..f868ee6bae8 --- /dev/null +++ b/website/docs/api-reference/configuration-storage/StorageV1beta1Api.md @@ -0,0 +1,719 @@ +--- +id: StorageV1beta1Api +title: StorageV1beta1Api +sidebar_label: StorageV1beta1Api +sidebar_position: 11 +--- +# StorageV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**deleteCollectionVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**deleteVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/StorageV1beta1Api#getAPIResources) | **GET** /apis/storage.k8s.io/v1beta1/ | +[**listVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**patchVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**readVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**replaceVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | + +### createVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass createVolumeAttributesClass(body) + +create a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiCreateVolumeAttributesClassRequest = { + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1VolumeAttributesClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionVolumeAttributesClass + + + +> V1Status deleteCollectionVolumeAttributesClass() + +delete collection of VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass deleteVolumeAttributesClass() + +delete a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiDeleteVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listVolumeAttributesClass + + + +> V1beta1VolumeAttributesClassList listVolumeAttributesClass() + +list or watch objects of kind VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiListVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass patchVolumeAttributesClass(body) + +partially update the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiPatchVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass readVolumeAttributesClass() + +read the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiReadVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass replaceVolumeAttributesClass(body) + +replace the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiReplaceVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1VolumeAttributesClass**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/StoragemigrationApi.md b/website/docs/api-reference/configuration-storage/StoragemigrationApi.md new file mode 100644 index 00000000000..c5297ac8c14 --- /dev/null +++ b/website/docs/api-reference/configuration-storage/StoragemigrationApi.md @@ -0,0 +1,62 @@ +--- +id: StoragemigrationApi +title: StoragemigrationApi +sidebar_label: StoragemigrationApi +sidebar_position: 8 +--- +# StoragemigrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/configuration-storage/StoragemigrationApi#getAPIGroup) | **GET** /apis/storagemigration.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, StoragemigrationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api.md b/website/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api.md new file mode 100644 index 00000000000..00238d62246 --- /dev/null +++ b/website/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api.md @@ -0,0 +1,1016 @@ +--- +id: StoragemigrationV1beta1Api +title: StoragemigrationV1beta1Api +sidebar_label: StoragemigrationV1beta1Api +sidebar_position: 9 +--- +# StoragemigrationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#createStorageVersionMigration) | **POST** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**deleteCollectionStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#deleteCollectionStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**deleteStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#deleteStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#getAPIResources) | **GET** /apis/storagemigration.k8s.io/v1beta1/ | +[**listStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#listStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**patchStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#patchStorageVersionMigration) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**patchStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#patchStorageVersionMigrationStatus) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | +[**readStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#readStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**readStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#readStorageVersionMigrationStatus) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | +[**replaceStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#replaceStorageVersionMigration) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**replaceStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#replaceStorageVersionMigrationStatus) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | + +### createStorageVersionMigration + + + +> V1beta1StorageVersionMigration createStorageVersionMigration(body) + +create a StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionStorageVersionMigration + + + +> V1Status deleteCollectionStorageVersionMigration() + +delete collection of StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteStorageVersionMigration + + + +> V1Status deleteStorageVersionMigration() + +delete a StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listStorageVersionMigration + + + +> V1beta1StorageVersionMigrationList listStorageVersionMigration() + +list or watch objects of kind StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiListStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiListStorageVersionMigrationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigrationList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchStorageVersionMigration + + + +> V1beta1StorageVersionMigration patchStorageVersionMigration(body) + +partially update the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchStorageVersionMigrationStatus + + + +> V1beta1StorageVersionMigration patchStorageVersionMigrationStatus(body) + +partially update status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readStorageVersionMigration + + + +> V1beta1StorageVersionMigration readStorageVersionMigration() + +read the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readStorageVersionMigrationStatus + + + +> V1beta1StorageVersionMigration readStorageVersionMigrationStatus() + +read status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceStorageVersionMigration + + + +> V1beta1StorageVersionMigration replaceStorageVersionMigration(body) + +replace the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceStorageVersionMigrationStatus + + + +> V1beta1StorageVersionMigration replaceStorageVersionMigrationStatus(body) + +replace status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/configuration-storage/_category_.json b/website/docs/api-reference/configuration-storage/_category_.json new file mode 100644 index 00000000000..6723fe67c06 --- /dev/null +++ b/website/docs/api-reference/configuration-storage/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Configuration & Storage", + "position": 5 +} diff --git a/website/docs/api-reference/core-resources/CoreApi.md b/website/docs/api-reference/core-resources/CoreApi.md new file mode 100644 index 00000000000..23689cf7d5a --- /dev/null +++ b/website/docs/api-reference/core-resources/CoreApi.md @@ -0,0 +1,62 @@ +--- +id: CoreApi +title: CoreApi +sidebar_label: CoreApi +sidebar_position: 1 +--- +# CoreApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIVersions**](/docs/api-reference/core-resources/CoreApi#getAPIVersions) | **GET** /api/ | + +### getAPIVersions + + + +> V1APIVersions getAPIVersions() + +get available API versions + +### Example + + +```typescript +import { createConfiguration, CoreApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIVersions(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIVersions + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/core-resources/CoreV1Api.md b/website/docs/api-reference/core-resources/CoreV1Api.md new file mode 100644 index 00000000000..13ef8d9adec --- /dev/null +++ b/website/docs/api-reference/core-resources/CoreV1Api.md @@ -0,0 +1,39221 @@ +--- +id: CoreV1Api +title: CoreV1Api +sidebar_label: CoreV1Api +sidebar_position: 2 +--- +# CoreV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**connectDeleteNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedPodProxy) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectDeleteNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedPodProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectDeleteNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedServiceProxy) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectDeleteNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedServiceProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectDeleteNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNodeProxy) | **DELETE** /api/v1/nodes/{name}/proxy | +[**connectDeleteNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNodeProxyWithPath) | **DELETE** /api/v1/nodes/{name}/proxy/{path} | +[**connectGetNamespacedPodAttach**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodAttach) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/attach | +[**connectGetNamespacedPodExec**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodExec) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/exec | +[**connectGetNamespacedPodPortforward**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodPortforward) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/portforward | +[**connectGetNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodProxy) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectGetNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectGetNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedServiceProxy) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectGetNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedServiceProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectGetNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNodeProxy) | **GET** /api/v1/nodes/{name}/proxy | +[**connectGetNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNodeProxyWithPath) | **GET** /api/v1/nodes/{name}/proxy/{path} | +[**connectHeadNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedPodProxy) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectHeadNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedPodProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectHeadNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedServiceProxy) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectHeadNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedServiceProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectHeadNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNodeProxy) | **HEAD** /api/v1/nodes/{name}/proxy | +[**connectHeadNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNodeProxyWithPath) | **HEAD** /api/v1/nodes/{name}/proxy/{path} | +[**connectOptionsNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedPodProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectOptionsNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedPodProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectOptionsNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedServiceProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectOptionsNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedServiceProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectOptionsNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNodeProxy) | **OPTIONS** /api/v1/nodes/{name}/proxy | +[**connectOptionsNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNodeProxyWithPath) | **OPTIONS** /api/v1/nodes/{name}/proxy/{path} | +[**connectPatchNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedPodProxy) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPatchNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedPodProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPatchNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedServiceProxy) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPatchNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedServiceProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPatchNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNodeProxy) | **PATCH** /api/v1/nodes/{name}/proxy | +[**connectPatchNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNodeProxyWithPath) | **PATCH** /api/v1/nodes/{name}/proxy/{path} | +[**connectPostNamespacedPodAttach**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodAttach) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/attach | +[**connectPostNamespacedPodExec**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodExec) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/exec | +[**connectPostNamespacedPodPortforward**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodPortforward) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/portforward | +[**connectPostNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodProxy) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPostNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPostNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedServiceProxy) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPostNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedServiceProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPostNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNodeProxy) | **POST** /api/v1/nodes/{name}/proxy | +[**connectPostNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNodeProxyWithPath) | **POST** /api/v1/nodes/{name}/proxy/{path} | +[**connectPutNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedPodProxy) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPutNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedPodProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPutNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedServiceProxy) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPutNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedServiceProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPutNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNodeProxy) | **PUT** /api/v1/nodes/{name}/proxy | +[**connectPutNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNodeProxyWithPath) | **PUT** /api/v1/nodes/{name}/proxy/{path} | +[**createNamespace**](/docs/api-reference/core-resources/CoreV1Api#createNamespace) | **POST** /api/v1/namespaces | +[**createNamespacedBinding**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedBinding) | **POST** /api/v1/namespaces/{namespace}/bindings | +[**createNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedConfigMap) | **POST** /api/v1/namespaces/{namespace}/configmaps | +[**createNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedEndpoints) | **POST** /api/v1/namespaces/{namespace}/endpoints | +[**createNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedEvent) | **POST** /api/v1/namespaces/{namespace}/events | +[**createNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedLimitRange) | **POST** /api/v1/namespaces/{namespace}/limitranges | +[**createNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPersistentVolumeClaim) | **POST** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**createNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPod) | **POST** /api/v1/namespaces/{namespace}/pods | +[**createNamespacedPodBinding**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodBinding) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/binding | +[**createNamespacedPodEviction**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodEviction) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/eviction | +[**createNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodTemplate) | **POST** /api/v1/namespaces/{namespace}/podtemplates | +[**createNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedReplicationController) | **POST** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**createNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedResourceQuota) | **POST** /api/v1/namespaces/{namespace}/resourcequotas | +[**createNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedSecret) | **POST** /api/v1/namespaces/{namespace}/secrets | +[**createNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedService) | **POST** /api/v1/namespaces/{namespace}/services | +[**createNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedServiceAccount) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts | +[**createNamespacedServiceAccountToken**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedServiceAccountToken) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token | +[**createNode**](/docs/api-reference/core-resources/CoreV1Api#createNode) | **POST** /api/v1/nodes | +[**createPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#createPersistentVolume) | **POST** /api/v1/persistentvolumes | +[**deleteCollectionNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps | +[**deleteCollectionNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints | +[**deleteCollectionNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events | +[**deleteCollectionNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges | +[**deleteCollectionNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**deleteCollectionNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods | +[**deleteCollectionNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates | +[**deleteCollectionNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**deleteCollectionNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas | +[**deleteCollectionNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets | +[**deleteCollectionNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services | +[**deleteCollectionNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts | +[**deleteCollectionNode**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNode) | **DELETE** /api/v1/nodes | +[**deleteCollectionPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionPersistentVolume) | **DELETE** /api/v1/persistentvolumes | +[**deleteNamespace**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespace) | **DELETE** /api/v1/namespaces/{name} | +[**deleteNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**deleteNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**deleteNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events/{name} | +[**deleteNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**deleteNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**deleteNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name} | +[**deleteNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**deleteNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**deleteNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**deleteNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets/{name} | +[**deleteNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services/{name} | +[**deleteNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**deleteNode**](/docs/api-reference/core-resources/CoreV1Api#deleteNode) | **DELETE** /api/v1/nodes/{name} | +[**deletePersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#deletePersistentVolume) | **DELETE** /api/v1/persistentvolumes/{name} | +[**getAPIResources**](/docs/api-reference/core-resources/CoreV1Api#getAPIResources) | **GET** /api/v1/ | +[**listComponentStatus**](/docs/api-reference/core-resources/CoreV1Api#listComponentStatus) | **GET** /api/v1/componentstatuses | +[**listConfigMapForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listConfigMapForAllNamespaces) | **GET** /api/v1/configmaps | +[**listEndpointsForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listEndpointsForAllNamespaces) | **GET** /api/v1/endpoints | +[**listEventForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listEventForAllNamespaces) | **GET** /api/v1/events | +[**listLimitRangeForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listLimitRangeForAllNamespaces) | **GET** /api/v1/limitranges | +[**listNamespace**](/docs/api-reference/core-resources/CoreV1Api#listNamespace) | **GET** /api/v1/namespaces | +[**listNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps | +[**listNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints | +[**listNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events | +[**listNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges | +[**listNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**listNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods | +[**listNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates | +[**listNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**listNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas | +[**listNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets | +[**listNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services | +[**listNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts | +[**listNode**](/docs/api-reference/core-resources/CoreV1Api#listNode) | **GET** /api/v1/nodes | +[**listPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#listPersistentVolume) | **GET** /api/v1/persistentvolumes | +[**listPersistentVolumeClaimForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPersistentVolumeClaimForAllNamespaces) | **GET** /api/v1/persistentvolumeclaims | +[**listPodForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPodForAllNamespaces) | **GET** /api/v1/pods | +[**listPodTemplateForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPodTemplateForAllNamespaces) | **GET** /api/v1/podtemplates | +[**listReplicationControllerForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listReplicationControllerForAllNamespaces) | **GET** /api/v1/replicationcontrollers | +[**listResourceQuotaForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listResourceQuotaForAllNamespaces) | **GET** /api/v1/resourcequotas | +[**listSecretForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listSecretForAllNamespaces) | **GET** /api/v1/secrets | +[**listServiceAccountForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listServiceAccountForAllNamespaces) | **GET** /api/v1/serviceaccounts | +[**listServiceForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listServiceForAllNamespaces) | **GET** /api/v1/services | +[**patchNamespace**](/docs/api-reference/core-resources/CoreV1Api#patchNamespace) | **PATCH** /api/v1/namespaces/{name} | +[**patchNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespaceStatus) | **PATCH** /api/v1/namespaces/{name}/status | +[**patchNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedConfigMap) | **PATCH** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**patchNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedEndpoints) | **PATCH** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**patchNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedEvent) | **PATCH** /api/v1/namespaces/{namespace}/events/{name} | +[**patchNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedLimitRange) | **PATCH** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**patchNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPersistentVolumeClaim) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**patchNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPersistentVolumeClaimStatus) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**patchNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPod) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name} | +[**patchNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodEphemeralcontainers) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**patchNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodResize) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**patchNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodStatus) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**patchNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodTemplate) | **PATCH** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**patchNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationController) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**patchNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationControllerScale) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**patchNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationControllerStatus) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**patchNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedResourceQuota) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**patchNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedResourceQuotaStatus) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**patchNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedSecret) | **PATCH** /api/v1/namespaces/{namespace}/secrets/{name} | +[**patchNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedService) | **PATCH** /api/v1/namespaces/{namespace}/services/{name} | +[**patchNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedServiceAccount) | **PATCH** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**patchNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedServiceStatus) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/status | +[**patchNode**](/docs/api-reference/core-resources/CoreV1Api#patchNode) | **PATCH** /api/v1/nodes/{name} | +[**patchNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNodeStatus) | **PATCH** /api/v1/nodes/{name}/status | +[**patchPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#patchPersistentVolume) | **PATCH** /api/v1/persistentvolumes/{name} | +[**patchPersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#patchPersistentVolumeStatus) | **PATCH** /api/v1/persistentvolumes/{name}/status | +[**readComponentStatus**](/docs/api-reference/core-resources/CoreV1Api#readComponentStatus) | **GET** /api/v1/componentstatuses/{name} | +[**readNamespace**](/docs/api-reference/core-resources/CoreV1Api#readNamespace) | **GET** /api/v1/namespaces/{name} | +[**readNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespaceStatus) | **GET** /api/v1/namespaces/{name}/status | +[**readNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**readNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**readNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events/{name} | +[**readNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**readNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**readNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPersistentVolumeClaimStatus) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**readNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods/{name} | +[**readNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodEphemeralcontainers) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**readNamespacedPodLog**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodLog) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/log | +[**readNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodResize) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**readNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodStatus) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**readNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**readNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**readNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationControllerScale) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**readNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationControllerStatus) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**readNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**readNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedResourceQuotaStatus) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**readNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets/{name} | +[**readNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services/{name} | +[**readNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**readNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedServiceStatus) | **GET** /api/v1/namespaces/{namespace}/services/{name}/status | +[**readNode**](/docs/api-reference/core-resources/CoreV1Api#readNode) | **GET** /api/v1/nodes/{name} | +[**readNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#readNodeStatus) | **GET** /api/v1/nodes/{name}/status | +[**readPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#readPersistentVolume) | **GET** /api/v1/persistentvolumes/{name} | +[**readPersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#readPersistentVolumeStatus) | **GET** /api/v1/persistentvolumes/{name}/status | +[**replaceNamespace**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespace) | **PUT** /api/v1/namespaces/{name} | +[**replaceNamespaceFinalize**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespaceFinalize) | **PUT** /api/v1/namespaces/{name}/finalize | +[**replaceNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespaceStatus) | **PUT** /api/v1/namespaces/{name}/status | +[**replaceNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedConfigMap) | **PUT** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**replaceNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedEndpoints) | **PUT** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**replaceNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedEvent) | **PUT** /api/v1/namespaces/{namespace}/events/{name} | +[**replaceNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedLimitRange) | **PUT** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**replaceNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPersistentVolumeClaim) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**replaceNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPersistentVolumeClaimStatus) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**replaceNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPod) | **PUT** /api/v1/namespaces/{namespace}/pods/{name} | +[**replaceNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodEphemeralcontainers) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**replaceNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodResize) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**replaceNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodStatus) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**replaceNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodTemplate) | **PUT** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**replaceNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationController) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**replaceNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationControllerScale) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**replaceNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationControllerStatus) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**replaceNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedResourceQuota) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**replaceNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedResourceQuotaStatus) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**replaceNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedSecret) | **PUT** /api/v1/namespaces/{namespace}/secrets/{name} | +[**replaceNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedService) | **PUT** /api/v1/namespaces/{namespace}/services/{name} | +[**replaceNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedServiceAccount) | **PUT** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**replaceNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedServiceStatus) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/status | +[**replaceNode**](/docs/api-reference/core-resources/CoreV1Api#replaceNode) | **PUT** /api/v1/nodes/{name} | +[**replaceNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNodeStatus) | **PUT** /api/v1/nodes/{name}/status | +[**replacePersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#replacePersistentVolume) | **PUT** /api/v1/persistentvolumes/{name} | +[**replacePersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#replacePersistentVolumeStatus) | **PUT** /api/v1/persistentvolumes/{name}/status | + +### connectDeleteNamespacedPodProxy + + + +> string connectDeleteNamespacedPodProxy() + +connect DELETE requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNamespacedPodProxyWithPath + + + +> string connectDeleteNamespacedPodProxyWithPath() + +connect DELETE requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNamespacedServiceProxy + + + +> string connectDeleteNamespacedServiceProxy() + +connect DELETE requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNamespacedServiceProxyWithPath + + + +> string connectDeleteNamespacedServiceProxyWithPath() + +connect DELETE requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNodeProxy + + + +> string connectDeleteNodeProxy() + +connect DELETE requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNodeProxyWithPath + + + +> string connectDeleteNodeProxyWithPath() + +connect DELETE requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodAttach + + + +> string connectGetNamespacedPodAttach() + +connect GET requests to attach of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodAttachRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodAttachRequest = { + // name of the PodAttachOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) + stderr: true, + // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectGetNamespacedPodAttach(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodAttachOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodExec + + + +> string connectGetNamespacedPodExec() + +connect GET requests to exec of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodExecRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodExecRequest = { + // name of the PodExecOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Command is the remote command to execute. argv array. Not executed within a shell. (optional) + command: "command_example", + // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Redirect the standard error stream of the pod for this call. (optional) + stderr: true, + // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Redirect the standard output stream of the pod for this call. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectGetNamespacedPodExec(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodExecOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined + **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined + **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodPortforward + + + +> string connectGetNamespacedPodPortforward() + +connect GET requests to portforward of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodPortforwardRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodPortforwardRequest = { + // name of the PodPortForwardOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // List of ports to forward Required when using WebSockets (optional) + ports: 1, +}; + +const data = await apiInstance.connectGetNamespacedPodPortforward(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodProxy + + + +> string connectGetNamespacedPodProxy() + +connect GET requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodProxyWithPath + + + +> string connectGetNamespacedPodProxyWithPath() + +connect GET requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedServiceProxy + + + +> string connectGetNamespacedServiceProxy() + +connect GET requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedServiceProxyWithPath + + + +> string connectGetNamespacedServiceProxyWithPath() + +connect GET requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNodeProxy + + + +> string connectGetNodeProxy() + +connect GET requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNodeProxyWithPath + + + +> string connectGetNodeProxyWithPath() + +connect GET requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNamespacedPodProxy + + + +> string connectHeadNamespacedPodProxy() + +connect HEAD requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNamespacedPodProxyWithPath + + + +> string connectHeadNamespacedPodProxyWithPath() + +connect HEAD requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNamespacedServiceProxy + + + +> string connectHeadNamespacedServiceProxy() + +connect HEAD requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNamespacedServiceProxyWithPath + + + +> string connectHeadNamespacedServiceProxyWithPath() + +connect HEAD requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNodeProxy + + + +> string connectHeadNodeProxy() + +connect HEAD requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNodeProxyWithPath + + + +> string connectHeadNodeProxyWithPath() + +connect HEAD requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNamespacedPodProxy + + + +> string connectOptionsNamespacedPodProxy() + +connect OPTIONS requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNamespacedPodProxyWithPath + + + +> string connectOptionsNamespacedPodProxyWithPath() + +connect OPTIONS requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNamespacedServiceProxy + + + +> string connectOptionsNamespacedServiceProxy() + +connect OPTIONS requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNamespacedServiceProxyWithPath + + + +> string connectOptionsNamespacedServiceProxyWithPath() + +connect OPTIONS requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNodeProxy + + + +> string connectOptionsNodeProxy() + +connect OPTIONS requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNodeProxyWithPath + + + +> string connectOptionsNodeProxyWithPath() + +connect OPTIONS requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNamespacedPodProxy + + + +> string connectPatchNamespacedPodProxy() + +connect PATCH requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNamespacedPodProxyWithPath + + + +> string connectPatchNamespacedPodProxyWithPath() + +connect PATCH requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNamespacedServiceProxy + + + +> string connectPatchNamespacedServiceProxy() + +connect PATCH requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNamespacedServiceProxyWithPath + + + +> string connectPatchNamespacedServiceProxyWithPath() + +connect PATCH requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNodeProxy + + + +> string connectPatchNodeProxy() + +connect PATCH requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNodeProxyWithPath + + + +> string connectPatchNodeProxyWithPath() + +connect PATCH requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodAttach + + + +> string connectPostNamespacedPodAttach() + +connect POST requests to attach of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodAttachRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodAttachRequest = { + // name of the PodAttachOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) + stderr: true, + // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectPostNamespacedPodAttach(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodAttachOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodExec + + + +> string connectPostNamespacedPodExec() + +connect POST requests to exec of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodExecRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodExecRequest = { + // name of the PodExecOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Command is the remote command to execute. argv array. Not executed within a shell. (optional) + command: "command_example", + // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Redirect the standard error stream of the pod for this call. (optional) + stderr: true, + // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Redirect the standard output stream of the pod for this call. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectPostNamespacedPodExec(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodExecOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined + **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined + **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodPortforward + + + +> string connectPostNamespacedPodPortforward() + +connect POST requests to portforward of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodPortforwardRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodPortforwardRequest = { + // name of the PodPortForwardOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // List of ports to forward Required when using WebSockets (optional) + ports: 1, +}; + +const data = await apiInstance.connectPostNamespacedPodPortforward(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodProxy + + + +> string connectPostNamespacedPodProxy() + +connect POST requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodProxyWithPath + + + +> string connectPostNamespacedPodProxyWithPath() + +connect POST requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedServiceProxy + + + +> string connectPostNamespacedServiceProxy() + +connect POST requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedServiceProxyWithPath + + + +> string connectPostNamespacedServiceProxyWithPath() + +connect POST requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNodeProxy + + + +> string connectPostNodeProxy() + +connect POST requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNodeProxyWithPath + + + +> string connectPostNodeProxyWithPath() + +connect POST requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNamespacedPodProxy + + + +> string connectPutNamespacedPodProxy() + +connect PUT requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNamespacedPodProxyWithPath + + + +> string connectPutNamespacedPodProxyWithPath() + +connect PUT requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNamespacedServiceProxy + + + +> string connectPutNamespacedServiceProxy() + +connect PUT requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNamespacedServiceProxyWithPath + + + +> string connectPutNamespacedServiceProxyWithPath() + +connect PUT requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNodeProxy + + + +> string connectPutNodeProxy() + +connect PUT requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNodeProxyWithPath + + + +> string connectPutNodeProxyWithPath() + +connect PUT requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### createNamespace + + + +> V1Namespace createNamespace(body) + +create a Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespaceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedBinding + + + +> V1Binding createNamespacedBinding(body) + +create a Binding + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + target: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Binding**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Binding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedConfigMap + + + +> V1ConfigMap createNamespacedConfigMap(body) + +create a ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + binaryData: { + "key": 'YQ==', + }, + data: { + "key": "key_example", + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ConfigMap**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ConfigMap + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedEndpoints + + + +> V1Endpoints createNamespacedEndpoints(body) + +create Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + subsets: [ + { + addresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + notReadyAddresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Endpoints**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Endpoints + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedEvent + + + +> CoreV1Event createNamespacedEvent(body) + +create an Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + count: 1, + eventTime: "eventTime_example", + firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + involvedObject: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + kind: "kind_example", + lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + reason: "reason_example", + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingComponent: "reportingComponent_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + source: { + component: "component_example", + host: "host_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **CoreV1Event**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +CoreV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedLimitRange + + + +> V1LimitRange createNamespacedLimitRange(body) + +create a LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + limits: [ + { + _default: { + "key": "key_example", + }, + defaultRequest: { + "key": "key_example", + }, + max: { + "key": "key_example", + }, + maxLimitRequestRatio: { + "key": "key_example", + }, + min: { + "key": "key_example", + }, + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LimitRange**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1LimitRange + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim createNamespacedPersistentVolumeClaim(body) + +create a PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPod + + + +> V1Pod createNamespacedPod(body) + +create a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPodBinding + + + +> V1Binding createNamespacedPodBinding(body) + +create binding of a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPodBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodBindingRequest = { + // name of the Binding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + target: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedPodBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Binding**| | + **name** | [**string**] | name of the Binding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Binding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPodEviction + + + +> V1Eviction createNamespacedPodEviction(body) + +create eviction of a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPodEvictionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodEvictionRequest = { + // name of the Eviction + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + deleteOptions: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedPodEviction(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Eviction**| | + **name** | [**string**] | name of the Eviction | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Eviction + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPodTemplate + + + +> V1PodTemplate createNamespacedPodTemplate(body) + +create a PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedReplicationController + + + +> V1ReplicationController createNamespacedReplicationController(body) + +create a ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceQuota + + + +> V1ResourceQuota createNamespacedResourceQuota(body) + +create a ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedSecret + + + +> V1Secret createNamespacedSecret(body) + +create a Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: { + "key": 'YQ==', + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + stringData: { + "key": "key_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Secret**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Secret + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedService + + + +> V1Service createNamespacedService(body) + +create a Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedServiceAccount + + + +> V1ServiceAccount createNamespacedServiceAccount(body) + +create a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + automountServiceAccountToken: true, + imagePullSecrets: [ + { + name: "name_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + secrets: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceAccount**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedServiceAccountToken + + + +> AuthenticationV1TokenRequest createNamespacedServiceAccountToken(body) + +create token of a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedServiceAccountTokenRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceAccountTokenRequest = { + // name of the TokenRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + audiences: [ + "audiences_example", + ], + boundObjectRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + expirationSeconds: 1, + }, + status: { + expirationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + token: "token_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedServiceAccountToken(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **AuthenticationV1TokenRequest**| | + **name** | [**string**] | name of the TokenRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +AuthenticationV1TokenRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNode + + + +> V1Node createNode(body) + +create a Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNodeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createPersistentVolume + + + +> V1PersistentVolume createPersistentVolume(body) + +create a PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreatePersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreatePersistentVolumeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedConfigMap + + + +> V1Status deleteCollectionNamespacedConfigMap() + +delete collection of ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedEndpoints + + + +> V1Status deleteCollectionNamespacedEndpoints() + +delete collection of Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedEvent + + + +> V1Status deleteCollectionNamespacedEvent() + +delete collection of Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedLimitRange + + + +> V1Status deleteCollectionNamespacedLimitRange() + +delete collection of LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPersistentVolumeClaim + + + +> V1Status deleteCollectionNamespacedPersistentVolumeClaim() + +delete collection of PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPod + + + +> V1Status deleteCollectionNamespacedPod() + +delete collection of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPodTemplate + + + +> V1Status deleteCollectionNamespacedPodTemplate() + +delete collection of PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedReplicationController + + + +> V1Status deleteCollectionNamespacedReplicationController() + +delete collection of ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceQuota + + + +> V1Status deleteCollectionNamespacedResourceQuota() + +delete collection of ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedSecret + + + +> V1Status deleteCollectionNamespacedSecret() + +delete collection of Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedService + + + +> V1Status deleteCollectionNamespacedService() + +delete collection of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedServiceAccount + + + +> V1Status deleteCollectionNamespacedServiceAccount() + +delete collection of ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNode + + + +> V1Status deleteCollectionNode() + +delete collection of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionPersistentVolume + + + +> V1Status deleteCollectionPersistentVolume() + +delete collection of PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionPersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionPersistentVolumeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespace + + + +> V1Status deleteNamespace() + +delete a Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespaceRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedConfigMap + + + +> V1Status deleteNamespacedConfigMap() + +delete a ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedEndpoints + + + +> V1Status deleteNamespacedEndpoints() + +delete Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedEvent + + + +> V1Status deleteNamespacedEvent() + +delete an Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedLimitRange + + + +> V1Status deleteNamespacedLimitRange() + +delete a LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim deleteNamespacedPersistentVolumeClaim() + +delete a PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedPod + + + +> V1Pod deleteNamespacedPod() + +delete a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedPodTemplate + + + +> V1PodTemplate deleteNamespacedPodTemplate() + +delete a PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedReplicationController + + + +> V1Status deleteNamespacedReplicationController() + +delete a ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceQuota + + + +> V1ResourceQuota deleteNamespacedResourceQuota() + +delete a ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedSecret + + + +> V1Status deleteNamespacedSecret() + +delete a Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedService + + + +> V1Service deleteNamespacedService() + +delete a Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedServiceAccount + + + +> V1ServiceAccount deleteNamespacedServiceAccount() + +delete a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNode + + + +> V1Status deleteNode() + +delete a Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNodeRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deletePersistentVolume + + + +> V1PersistentVolume deletePersistentVolume() + +delete a PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeletePersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeletePersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listComponentStatus + + + +> V1ComponentStatusList listComponentStatus() + +list objects of kind ComponentStatus + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListComponentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListComponentStatusRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listComponentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ComponentStatusList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listConfigMapForAllNamespaces + + + +> V1ConfigMapList listConfigMapForAllNamespaces() + +list or watch objects of kind ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListConfigMapForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListConfigMapForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listConfigMapForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ConfigMapList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listEndpointsForAllNamespaces + + + +> V1EndpointsList listEndpointsForAllNamespaces() + +list or watch objects of kind Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListEndpointsForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListEndpointsForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEndpointsForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1EndpointsList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listEventForAllNamespaces + + + +> CoreV1EventList listEventForAllNamespaces() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListEventForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListEventForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEventForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +CoreV1EventList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listLimitRangeForAllNamespaces + + + +> V1LimitRangeList listLimitRangeForAllNamespaces() + +list or watch objects of kind LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListLimitRangeForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListLimitRangeForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLimitRangeForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1LimitRangeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespace + + + +> V1NamespaceList listNamespace() + +list or watch objects of kind Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespaceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1NamespaceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedConfigMap + + + +> V1ConfigMapList listNamespacedConfigMap() + +list or watch objects of kind ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ConfigMapList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedEndpoints + + + +> V1EndpointsList listNamespacedEndpoints() + +list or watch objects of kind Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1EndpointsList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedEvent + + + +> CoreV1EventList listNamespacedEvent() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +CoreV1EventList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedLimitRange + + + +> V1LimitRangeList listNamespacedLimitRange() + +list or watch objects of kind LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1LimitRangeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaimList listNamespacedPersistentVolumeClaim() + +list or watch objects of kind PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPod + + + +> V1PodList listNamespacedPod() + +list or watch objects of kind Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPodTemplate + + + +> V1PodTemplateList listNamespacedPodTemplate() + +list or watch objects of kind PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedReplicationController + + + +> V1ReplicationControllerList listNamespacedReplicationController() + +list or watch objects of kind ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ReplicationControllerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceQuota + + + +> V1ResourceQuotaList listNamespacedResourceQuota() + +list or watch objects of kind ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceQuotaList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedSecret + + + +> V1SecretList listNamespacedSecret() + +list or watch objects of kind Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1SecretList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedService + + + +> V1ServiceList listNamespacedService() + +list or watch objects of kind Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedServiceAccount + + + +> V1ServiceAccountList listNamespacedServiceAccount() + +list or watch objects of kind ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceAccountList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNode + + + +> V1NodeList listNode() + +list or watch objects of kind Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1NodeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPersistentVolume + + + +> V1PersistentVolumeList listPersistentVolume() + +list or watch objects of kind PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListPersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPersistentVolumeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPersistentVolumeClaimForAllNamespaces + + + +> V1PersistentVolumeClaimList listPersistentVolumeClaimForAllNamespaces() + +list or watch objects of kind PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPersistentVolumeClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPodForAllNamespaces + + + +> V1PodList listPodForAllNamespaces() + +list or watch objects of kind Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListPodForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPodForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPodTemplateForAllNamespaces + + + +> V1PodTemplateList listPodTemplateForAllNamespaces() + +list or watch objects of kind PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListPodTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPodTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listReplicationControllerForAllNamespaces + + + +> V1ReplicationControllerList listReplicationControllerForAllNamespaces() + +list or watch objects of kind ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListReplicationControllerForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListReplicationControllerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listReplicationControllerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ReplicationControllerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceQuotaForAllNamespaces + + + +> V1ResourceQuotaList listResourceQuotaForAllNamespaces() + +list or watch objects of kind ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListResourceQuotaForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListResourceQuotaForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceQuotaForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceQuotaList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listSecretForAllNamespaces + + + +> V1SecretList listSecretForAllNamespaces() + +list or watch objects of kind Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListSecretForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListSecretForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listSecretForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1SecretList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listServiceAccountForAllNamespaces + + + +> V1ServiceAccountList listServiceAccountForAllNamespaces() + +list or watch objects of kind ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListServiceAccountForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListServiceAccountForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceAccountForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceAccountList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listServiceForAllNamespaces + + + +> V1ServiceList listServiceForAllNamespaces() + +list or watch objects of kind Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListServiceForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListServiceForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespace + + + +> V1Namespace patchNamespace(body) + +partially update the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespaceRequest = { + // name of the Namespace + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespaceStatus + + + +> V1Namespace patchNamespaceStatus(body) + +partially update status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespaceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedConfigMap + + + +> V1ConfigMap patchNamespacedConfigMap(body) + +partially update the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ConfigMap + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedEndpoints + + + +> V1Endpoints patchNamespacedEndpoints(body) + +partially update the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Endpoints + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedEvent + + + +> CoreV1Event patchNamespacedEvent(body) + +partially update the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +CoreV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedLimitRange + + + +> V1LimitRange patchNamespacedLimitRange(body) + +partially update the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1LimitRange + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaim(body) + +partially update the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPersistentVolumeClaimStatus + + + +> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaimStatus(body) + +partially update status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPod + + + +> V1Pod patchNamespacedPod(body) + +partially update the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodEphemeralcontainers + + + +> V1Pod patchNamespacedPodEphemeralcontainers(body) + +partially update ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodResize + + + +> V1Pod patchNamespacedPodResize(body) + +partially update resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodResizeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodStatus + + + +> V1Pod patchNamespacedPodStatus(body) + +partially update status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodTemplate + + + +> V1PodTemplate patchNamespacedPodTemplate(body) + +partially update the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicationController + + + +> V1ReplicationController patchNamespacedReplicationController(body) + +partially update the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicationControllerScale + + + +> V1Scale patchNamespacedReplicationControllerScale(body) + +partially update scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicationControllerStatus + + + +> V1ReplicationController patchNamespacedReplicationControllerStatus(body) + +partially update status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceQuota + + + +> V1ResourceQuota patchNamespacedResourceQuota(body) + +partially update the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceQuotaStatus + + + +> V1ResourceQuota patchNamespacedResourceQuotaStatus(body) + +partially update status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedSecret + + + +> V1Secret patchNamespacedSecret(body) + +partially update the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Secret + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedService + + + +> V1Service patchNamespacedService(body) + +partially update the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedServiceAccount + + + +> V1ServiceAccount patchNamespacedServiceAccount(body) + +partially update the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedServiceStatus + + + +> V1Service patchNamespacedServiceStatus(body) + +partially update status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNode + + + +> V1Node patchNode(body) + +partially update the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNodeRequest = { + // name of the Node + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNodeStatus + + + +> V1Node patchNodeStatus(body) + +partially update status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNodeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNodeStatusRequest = { + // name of the Node + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchPersistentVolume + + + +> V1PersistentVolume patchPersistentVolume(body) + +partially update the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchPersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchPersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchPersistentVolumeStatus + + + +> V1PersistentVolume patchPersistentVolumeStatus(body) + +partially update status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchPersistentVolumeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchPersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readComponentStatus + + + +> V1ComponentStatus readComponentStatus() + +read the specified ComponentStatus + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadComponentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadComponentStatusRequest = { + // name of the ComponentStatus + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readComponentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ComponentStatus | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ComponentStatus + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespace + + + +> V1Namespace readNamespace() + +read the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespaceRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespaceStatus + + + +> V1Namespace readNamespaceStatus() + +read status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespaceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedConfigMap + + + +> V1ConfigMap readNamespacedConfigMap() + +read the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ConfigMap + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedEndpoints + + + +> V1Endpoints readNamespacedEndpoints() + +read the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Endpoints + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedEvent + + + +> CoreV1Event readNamespacedEvent() + +read the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +CoreV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedLimitRange + + + +> V1LimitRange readNamespacedLimitRange() + +read the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1LimitRange + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaim() + +read the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPersistentVolumeClaimStatus + + + +> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaimStatus() + +read status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPod + + + +> V1Pod readNamespacedPod() + +read the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodEphemeralcontainers + + + +> V1Pod readNamespacedPodEphemeralcontainers() + +read ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodLog + + + +> string readNamespacedPodLog() + +read log of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodLogRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodLogRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container for which to stream logs. Defaults to only container if there is one container in the pod. (optional) + container: "container_example", + // Follow the log stream of the pod. Defaults to false. (optional) + follow: true, + // insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). (optional) + insecureSkipTLSVerifyBackend: true, + // If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. (optional) + limitBytes: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // Return previous terminated container logs. Defaults to false. (optional) + previous: true, + // A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. (optional) + sinceSeconds: 1, + // Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) + stream: "stream_example", + // If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) + tailLines: 1, + // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. (optional) + timestamps: true, +}; + +const data = await apiInstance.readNamespacedPodLog(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container for which to stream logs. Defaults to only container if there is one container in the pod. | (optional) defaults to undefined + **follow** | [**boolean**] | Follow the log stream of the pod. Defaults to false. | (optional) defaults to undefined + **insecureSkipTLSVerifyBackend** | [**boolean**] | insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). | (optional) defaults to undefined + **limitBytes** | [**number**] | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **previous** | [**boolean**] | Return previous terminated container logs. Defaults to false. | (optional) defaults to undefined + **sinceSeconds** | [**number**] | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | (optional) defaults to undefined + **stream** | [**string**] | Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined + **tailLines** | [**number**] | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined + **timestamps** | [**boolean**] | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodResize + + + +> V1Pod readNamespacedPodResize() + +read resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodResizeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodStatus + + + +> V1Pod readNamespacedPodStatus() + +read status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodTemplate + + + +> V1PodTemplate readNamespacedPodTemplate() + +read the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicationController + + + +> V1ReplicationController readNamespacedReplicationController() + +read the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicationControllerScale + + + +> V1Scale readNamespacedReplicationControllerScale() + +read scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicationControllerStatus + + + +> V1ReplicationController readNamespacedReplicationControllerStatus() + +read status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceQuota + + + +> V1ResourceQuota readNamespacedResourceQuota() + +read the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceQuotaStatus + + + +> V1ResourceQuota readNamespacedResourceQuotaStatus() + +read status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedSecret + + + +> V1Secret readNamespacedSecret() + +read the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Secret + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedService + + + +> V1Service readNamespacedService() + +read the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedServiceAccount + + + +> V1ServiceAccount readNamespacedServiceAccount() + +read the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedServiceStatus + + + +> V1Service readNamespacedServiceStatus() + +read status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNode + + + +> V1Node readNode() + +read the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNodeRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNodeStatus + + + +> V1Node readNodeStatus() + +read status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNodeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNodeStatusRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readPersistentVolume + + + +> V1PersistentVolume readPersistentVolume() + +read the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadPersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadPersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readPersistentVolumeStatus + + + +> V1PersistentVolume readPersistentVolumeStatus() + +read status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadPersistentVolumeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadPersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespace + + + +> V1Namespace replaceNamespace(body) + +replace the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespaceFinalize + + + +> V1Namespace replaceNamespaceFinalize(body) + +replace finalize of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespaceFinalizeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceFinalizeRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.replaceNamespaceFinalize(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespaceStatus + + + +> V1Namespace replaceNamespaceStatus(body) + +replace status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespaceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedConfigMap + + + +> V1ConfigMap replaceNamespacedConfigMap(body) + +replace the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + binaryData: { + "key": 'YQ==', + }, + data: { + "key": "key_example", + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ConfigMap**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ConfigMap + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedEndpoints + + + +> V1Endpoints replaceNamespacedEndpoints(body) + +replace the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + subsets: [ + { + addresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + notReadyAddresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Endpoints**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Endpoints + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedEvent + + + +> CoreV1Event replaceNamespacedEvent(body) + +replace the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + count: 1, + eventTime: "eventTime_example", + firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + involvedObject: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + kind: "kind_example", + lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + reason: "reason_example", + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingComponent: "reportingComponent_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + source: { + component: "component_example", + host: "host_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **CoreV1Event**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +CoreV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedLimitRange + + + +> V1LimitRange replaceNamespacedLimitRange(body) + +replace the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + limits: [ + { + _default: { + "key": "key_example", + }, + defaultRequest: { + "key": "key_example", + }, + max: { + "key": "key_example", + }, + maxLimitRequestRatio: { + "key": "key_example", + }, + min: { + "key": "key_example", + }, + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LimitRange**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1LimitRange + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaim(body) + +replace the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPersistentVolumeClaimStatus + + + +> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaimStatus(body) + +replace status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPod + + + +> V1Pod replaceNamespacedPod(body) + +replace the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodEphemeralcontainers + + + +> V1Pod replaceNamespacedPodEphemeralcontainers(body) + +replace ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodResize + + + +> V1Pod replaceNamespacedPodResize(body) + +replace resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodResizeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodStatus + + + +> V1Pod replaceNamespacedPodStatus(body) + +replace status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodTemplate + + + +> V1PodTemplate replaceNamespacedPodTemplate(body) + +replace the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodTemplate**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicationController + + + +> V1ReplicationController replaceNamespacedReplicationController(body) + +replace the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicationControllerScale + + + +> V1Scale replaceNamespacedReplicationControllerScale(body) + +replace scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicationControllerStatus + + + +> V1ReplicationController replaceNamespacedReplicationControllerStatus(body) + +replace status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceQuota + + + +> V1ResourceQuota replaceNamespacedResourceQuota(body) + +replace the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceQuotaStatus + + + +> V1ResourceQuota replaceNamespacedResourceQuotaStatus(body) + +replace status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedSecret + + + +> V1Secret replaceNamespacedSecret(body) + +replace the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: { + "key": 'YQ==', + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + stringData: { + "key": "key_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Secret**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Secret + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedService + + + +> V1Service replaceNamespacedService(body) + +replace the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedServiceAccount + + + +> V1ServiceAccount replaceNamespacedServiceAccount(body) + +replace the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + automountServiceAccountToken: true, + imagePullSecrets: [ + { + name: "name_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + secrets: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceAccount**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedServiceStatus + + + +> V1Service replaceNamespacedServiceStatus(body) + +replace status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNode + + + +> V1Node replaceNode(body) + +replace the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNodeRequest = { + // name of the Node + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNodeStatus + + + +> V1Node replaceNodeStatus(body) + +replace status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNodeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNodeStatusRequest = { + // name of the Node + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replacePersistentVolume + + + +> V1PersistentVolume replacePersistentVolume(body) + +replace the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplacePersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplacePersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replacePersistentVolumeStatus + + + +> V1PersistentVolume replacePersistentVolumeStatus(body) + +replace status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplacePersistentVolumeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplacePersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/core-resources/EventsApi.md b/website/docs/api-reference/core-resources/EventsApi.md new file mode 100644 index 00000000000..891d445a1e7 --- /dev/null +++ b/website/docs/api-reference/core-resources/EventsApi.md @@ -0,0 +1,62 @@ +--- +id: EventsApi +title: EventsApi +sidebar_label: EventsApi +sidebar_position: 3 +--- +# EventsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/core-resources/EventsApi#getAPIGroup) | **GET** /apis/events.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, EventsApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/core-resources/EventsV1Api.md b/website/docs/api-reference/core-resources/EventsV1Api.md new file mode 100644 index 00000000000..fd13c6f99c2 --- /dev/null +++ b/website/docs/api-reference/core-resources/EventsV1Api.md @@ -0,0 +1,889 @@ +--- +id: EventsV1Api +title: EventsV1Api +sidebar_label: EventsV1Api +sidebar_position: 4 +--- +# EventsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#createNamespacedEvent) | **POST** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**deleteCollectionNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#deleteCollectionNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**deleteNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#deleteNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**getAPIResources**](/docs/api-reference/core-resources/EventsV1Api#getAPIResources) | **GET** /apis/events.k8s.io/v1/ | +[**listEventForAllNamespaces**](/docs/api-reference/core-resources/EventsV1Api#listEventForAllNamespaces) | **GET** /apis/events.k8s.io/v1/events | +[**listNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#listNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**patchNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#patchNamespacedEvent) | **PATCH** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**readNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#readNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**replaceNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#replaceNamespacedEvent) | **PUT** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | + +### createNamespacedEvent + + + +> EventsV1Event createNamespacedEvent(body) + +create an Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiCreateNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiCreateNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + deprecatedCount: 1, + deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedSource: { + component: "component_example", + host: "host_example", + }, + eventTime: "eventTime_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + note: "note_example", + reason: "reason_example", + regarding: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingController: "reportingController_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **EventsV1Event**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +EventsV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedEvent + + + +> V1Status deleteCollectionNamespacedEvent() + +delete collection of Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiDeleteCollectionNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiDeleteCollectionNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedEvent + + + +> V1Status deleteNamespacedEvent() + +delete an Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiDeleteNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiDeleteNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listEventForAllNamespaces + + + +> EventsV1EventList listEventForAllNamespaces() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiListEventForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiListEventForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEventForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +EventsV1EventList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedEvent + + + +> EventsV1EventList listNamespacedEvent() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiListNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiListNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +EventsV1EventList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedEvent + + + +> EventsV1Event patchNamespacedEvent(body) + +partially update the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiPatchNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiPatchNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +EventsV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedEvent + + + +> EventsV1Event readNamespacedEvent() + +read the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiReadNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiReadNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +EventsV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedEvent + + + +> EventsV1Event replaceNamespacedEvent(body) + +replace the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiReplaceNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiReplaceNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + deprecatedCount: 1, + deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedSource: { + component: "component_example", + host: "host_example", + }, + eventTime: "eventTime_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + note: "note_example", + reason: "reason_example", + regarding: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingController: "reportingController_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **EventsV1Event**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +EventsV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/core-resources/NodeApi.md b/website/docs/api-reference/core-resources/NodeApi.md new file mode 100644 index 00000000000..975a97e8ac4 --- /dev/null +++ b/website/docs/api-reference/core-resources/NodeApi.md @@ -0,0 +1,62 @@ +--- +id: NodeApi +title: NodeApi +sidebar_label: NodeApi +sidebar_position: 5 +--- +# NodeApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/core-resources/NodeApi#getAPIGroup) | **GET** /apis/node.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, NodeApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/core-resources/NodeV1Api.md b/website/docs/api-reference/core-resources/NodeV1Api.md new file mode 100644 index 00000000000..95f49bda4a8 --- /dev/null +++ b/website/docs/api-reference/core-resources/NodeV1Api.md @@ -0,0 +1,751 @@ +--- +id: NodeV1Api +title: NodeV1Api +sidebar_label: NodeV1Api +sidebar_position: 6 +--- +# NodeV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#createRuntimeClass) | **POST** /apis/node.k8s.io/v1/runtimeclasses | +[**deleteCollectionRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#deleteCollectionRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses | +[**deleteRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#deleteRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**getAPIResources**](/docs/api-reference/core-resources/NodeV1Api#getAPIResources) | **GET** /apis/node.k8s.io/v1/ | +[**listRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#listRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses | +[**patchRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#patchRuntimeClass) | **PATCH** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**readRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#readRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**replaceRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#replaceRuntimeClass) | **PUT** /apis/node.k8s.io/v1/runtimeclasses/{name} | + +### createRuntimeClass + + + +> V1RuntimeClass createRuntimeClass(body) + +create a RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiCreateRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiCreateRuntimeClassRequest = { + + body: { + apiVersion: "apiVersion_example", + handler: "handler_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + overhead: { + podFixed: { + "key": "key_example", + }, + }, + scheduling: { + nodeSelector: { + "key": "key_example", + }, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RuntimeClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1RuntimeClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionRuntimeClass + + + +> V1Status deleteCollectionRuntimeClass() + +delete collection of RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiDeleteCollectionRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiDeleteCollectionRuntimeClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteRuntimeClass + + + +> V1Status deleteRuntimeClass() + +delete a RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiDeleteRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiDeleteRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listRuntimeClass + + + +> V1RuntimeClassList listRuntimeClass() + +list or watch objects of kind RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiListRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiListRuntimeClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RuntimeClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchRuntimeClass + + + +> V1RuntimeClass patchRuntimeClass(body) + +partially update the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiPatchRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiPatchRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1RuntimeClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readRuntimeClass + + + +> V1RuntimeClass readRuntimeClass() + +read the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiReadRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiReadRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1RuntimeClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceRuntimeClass + + + +> V1RuntimeClass replaceRuntimeClass(body) + +replace the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiReplaceRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiReplaceRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + handler: "handler_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + overhead: { + podFixed: { + "key": "key_example", + }, + }, + scheduling: { + nodeSelector: { + "key": "key_example", + }, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RuntimeClass**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1RuntimeClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/core-resources/_category_.json b/website/docs/api-reference/core-resources/_category_.json new file mode 100644 index 00000000000..b8f850a4d43 --- /dev/null +++ b/website/docs/api-reference/core-resources/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Core Resources", + "position": 1 +} diff --git a/website/docs/api-reference/networking/DiscoveryApi.md b/website/docs/api-reference/networking/DiscoveryApi.md new file mode 100644 index 00000000000..ba4ca020e47 --- /dev/null +++ b/website/docs/api-reference/networking/DiscoveryApi.md @@ -0,0 +1,62 @@ +--- +id: DiscoveryApi +title: DiscoveryApi +sidebar_label: DiscoveryApi +sidebar_position: 1 +--- +# DiscoveryApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/networking/DiscoveryApi#getAPIGroup) | **GET** /apis/discovery.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, DiscoveryApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/networking/DiscoveryV1Api.md b/website/docs/api-reference/networking/DiscoveryV1Api.md new file mode 100644 index 00000000000..d9fcde9ab2f --- /dev/null +++ b/website/docs/api-reference/networking/DiscoveryV1Api.md @@ -0,0 +1,913 @@ +--- +id: DiscoveryV1Api +title: DiscoveryV1Api +sidebar_label: DiscoveryV1Api +sidebar_position: 2 +--- +# DiscoveryV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#createNamespacedEndpointSlice) | **POST** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**deleteCollectionNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#deleteCollectionNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**deleteNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#deleteNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**getAPIResources**](/docs/api-reference/networking/DiscoveryV1Api#getAPIResources) | **GET** /apis/discovery.k8s.io/v1/ | +[**listEndpointSliceForAllNamespaces**](/docs/api-reference/networking/DiscoveryV1Api#listEndpointSliceForAllNamespaces) | **GET** /apis/discovery.k8s.io/v1/endpointslices | +[**listNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#listNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**patchNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#patchNamespacedEndpointSlice) | **PATCH** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**readNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#readNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**replaceNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#replaceNamespacedEndpointSlice) | **PUT** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | + +### createNamespacedEndpointSlice + + + +> V1EndpointSlice createNamespacedEndpointSlice(body) + +create an EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiCreateNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiCreateNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + addressType: "addressType_example", + apiVersion: "apiVersion_example", + endpoints: [ + { + addresses: [ + "addresses_example", + ], + conditions: { + ready: true, + serving: true, + terminating: true, + }, + deprecatedTopology: { + "key": "key_example", + }, + hints: { + forNodes: [ + { + name: "name_example", + }, + ], + forZones: [ + { + name: "name_example", + }, + ], + }, + hostname: "hostname_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + zone: "zone_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1EndpointSlice**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1EndpointSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedEndpointSlice + + + +> V1Status deleteCollectionNamespacedEndpointSlice() + +delete collection of EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedEndpointSlice + + + +> V1Status deleteNamespacedEndpointSlice() + +delete an EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listEndpointSliceForAllNamespaces + + + +> V1EndpointSliceList listEndpointSliceForAllNamespaces() + +list or watch objects of kind EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEndpointSliceForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1EndpointSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedEndpointSlice + + + +> V1EndpointSliceList listNamespacedEndpointSlice() + +list or watch objects of kind EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiListNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiListNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1EndpointSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedEndpointSlice + + + +> V1EndpointSlice patchNamespacedEndpointSlice(body) + +partially update the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiPatchNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiPatchNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1EndpointSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedEndpointSlice + + + +> V1EndpointSlice readNamespacedEndpointSlice() + +read the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiReadNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiReadNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1EndpointSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedEndpointSlice + + + +> V1EndpointSlice replaceNamespacedEndpointSlice(body) + +replace the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + addressType: "addressType_example", + apiVersion: "apiVersion_example", + endpoints: [ + { + addresses: [ + "addresses_example", + ], + conditions: { + ready: true, + serving: true, + terminating: true, + }, + deprecatedTopology: { + "key": "key_example", + }, + hints: { + forNodes: [ + { + name: "name_example", + }, + ], + forZones: [ + { + name: "name_example", + }, + ], + }, + hostname: "hostname_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + zone: "zone_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1EndpointSlice**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1EndpointSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/networking/NetworkingApi.md b/website/docs/api-reference/networking/NetworkingApi.md new file mode 100644 index 00000000000..47fb65146fa --- /dev/null +++ b/website/docs/api-reference/networking/NetworkingApi.md @@ -0,0 +1,62 @@ +--- +id: NetworkingApi +title: NetworkingApi +sidebar_label: NetworkingApi +sidebar_position: 3 +--- +# NetworkingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/networking/NetworkingApi#getAPIGroup) | **GET** /apis/networking.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, NetworkingApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/networking/NetworkingV1Api.md b/website/docs/api-reference/networking/NetworkingV1Api.md new file mode 100644 index 00000000000..b49013d79f0 --- /dev/null +++ b/website/docs/api-reference/networking/NetworkingV1Api.md @@ -0,0 +1,4552 @@ +--- +id: NetworkingV1Api +title: NetworkingV1Api +sidebar_label: NetworkingV1Api +sidebar_position: 4 +--- +# NetworkingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createIPAddress**](/docs/api-reference/networking/NetworkingV1Api#createIPAddress) | **POST** /apis/networking.k8s.io/v1/ipaddresses | +[**createIngressClass**](/docs/api-reference/networking/NetworkingV1Api#createIngressClass) | **POST** /apis/networking.k8s.io/v1/ingressclasses | +[**createNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#createNamespacedIngress) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**createNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#createNamespacedNetworkPolicy) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**createServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1/servicecidrs | +[**deleteCollectionIPAddress**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses | +[**deleteCollectionIngressClass**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses | +[**deleteCollectionNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**deleteCollectionNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**deleteCollectionServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs | +[**deleteIPAddress**](/docs/api-reference/networking/NetworkingV1Api#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**deleteIngressClass**](/docs/api-reference/networking/NetworkingV1Api#deleteIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**deleteNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#deleteNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**deleteNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#deleteNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**deleteServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**getAPIResources**](/docs/api-reference/networking/NetworkingV1Api#getAPIResources) | **GET** /apis/networking.k8s.io/v1/ | +[**listIPAddress**](/docs/api-reference/networking/NetworkingV1Api#listIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses | +[**listIngressClass**](/docs/api-reference/networking/NetworkingV1Api#listIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses | +[**listIngressForAllNamespaces**](/docs/api-reference/networking/NetworkingV1Api#listIngressForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/ingresses | +[**listNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#listNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**listNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#listNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**listNetworkPolicyForAllNamespaces**](/docs/api-reference/networking/NetworkingV1Api#listNetworkPolicyForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/networkpolicies | +[**listServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs | +[**patchIPAddress**](/docs/api-reference/networking/NetworkingV1Api#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**patchIngressClass**](/docs/api-reference/networking/NetworkingV1Api#patchIngressClass) | **PATCH** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**patchNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedIngress) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**patchNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedIngressStatus) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**patchNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedNetworkPolicy) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**patchServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**patchServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | +[**readIPAddress**](/docs/api-reference/networking/NetworkingV1Api#readIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**readIngressClass**](/docs/api-reference/networking/NetworkingV1Api#readIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**readNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**readNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedIngressStatus) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**readNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**readServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**readServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | +[**replaceIPAddress**](/docs/api-reference/networking/NetworkingV1Api#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**replaceIngressClass**](/docs/api-reference/networking/NetworkingV1Api#replaceIngressClass) | **PUT** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**replaceNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedIngress) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**replaceNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedIngressStatus) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**replaceNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedNetworkPolicy) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**replaceServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**replaceServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | + +### createIPAddress + + + +> V1IPAddress createIPAddress(body) + +create an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateIPAddressRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IPAddress**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createIngressClass + + + +> V1IngressClass createIngressClass(body) + +create an IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateIngressClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controller: "controller_example", + parameters: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + scope: "scope_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IngressClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1IngressClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedIngress + + + +> V1Ingress createNamespacedIngress(body) + +create an Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedNetworkPolicy + + + +> V1NetworkPolicy createNamespacedNetworkPolicy(body) + +create a NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + egress: [ + { + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + to: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + }, + ], + ingress: [ + { + _from: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + }, + ], + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + policyTypes: [ + "policyTypes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1NetworkPolicy**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createServiceCIDR + + + +> V1ServiceCIDR createServiceCIDR(body) + +create a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateServiceCIDRRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionIPAddress + + + +> V1Status deleteCollectionIPAddress() + +delete collection of IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionIngressClass + + + +> V1Status deleteCollectionIngressClass() + +delete collection of IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionIngressClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedIngress + + + +> V1Status deleteCollectionNamespacedIngress() + +delete collection of Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedNetworkPolicy + + + +> V1Status deleteCollectionNamespacedNetworkPolicy() + +delete collection of NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionServiceCIDR + + + +> V1Status deleteCollectionServiceCIDR() + +delete collection of ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteIPAddress + + + +> V1Status deleteIPAddress() + +delete an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteIngressClass + + + +> V1Status deleteIngressClass() + +delete an IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteIngressClassRequest = { + // name of the IngressClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedIngress + + + +> V1Status deleteNamespacedIngress() + +delete an Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedNetworkPolicy + + + +> V1Status deleteNamespacedNetworkPolicy() + +delete a NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteServiceCIDR + + + +> V1Status deleteServiceCIDR() + +delete a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listIPAddress + + + +> V1IPAddressList listIPAddress() + +list or watch objects of kind IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1IPAddressList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listIngressClass + + + +> V1IngressClassList listIngressClass() + +list or watch objects of kind IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIngressClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1IngressClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listIngressForAllNamespaces + + + +> V1IngressList listIngressForAllNamespaces() + +list or watch objects of kind Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListIngressForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIngressForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIngressForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1IngressList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedIngress + + + +> V1IngressList listNamespacedIngress() + +list or watch objects of kind Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1IngressList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedNetworkPolicy + + + +> V1NetworkPolicyList listNamespacedNetworkPolicy() + +list or watch objects of kind NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNetworkPolicyForAllNamespaces + + + +> V1NetworkPolicyList listNetworkPolicyForAllNamespaces() + +list or watch objects of kind NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNetworkPolicyForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listServiceCIDR + + + +> V1ServiceCIDRList listServiceCIDR() + +list or watch objects of kind ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDRList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchIPAddress + + + +> V1IPAddress patchIPAddress(body) + +partially update the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchIngressClass + + + +> V1IngressClass patchIngressClass(body) + +partially update the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchIngressClassRequest = { + // name of the IngressClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1IngressClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedIngress + + + +> V1Ingress patchNamespacedIngress(body) + +partially update the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedIngressStatus + + + +> V1Ingress patchNamespacedIngressStatus(body) + +partially update status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchNamespacedIngressStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedNetworkPolicy + + + +> V1NetworkPolicy patchNamespacedNetworkPolicy(body) + +partially update the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchServiceCIDR + + + +> V1ServiceCIDR patchServiceCIDR(body) + +partially update the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchServiceCIDRStatus + + + +> V1ServiceCIDR patchServiceCIDRStatus(body) + +partially update status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readIPAddress + + + +> V1IPAddress readIPAddress() + +read the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readIngressClass + + + +> V1IngressClass readIngressClass() + +read the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadIngressClassRequest = { + // name of the IngressClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1IngressClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedIngress + + + +> V1Ingress readNamespacedIngress() + +read the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedIngressStatus + + + +> V1Ingress readNamespacedIngressStatus() + +read status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadNamespacedIngressStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedNetworkPolicy + + + +> V1NetworkPolicy readNamespacedNetworkPolicy() + +read the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1NetworkPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readServiceCIDR + + + +> V1ServiceCIDR readServiceCIDR() + +read the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readServiceCIDRStatus + + + +> V1ServiceCIDR readServiceCIDRStatus() + +read status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceIPAddress + + + +> V1IPAddress replaceIPAddress(body) + +replace the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IPAddress**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceIngressClass + + + +> V1IngressClass replaceIngressClass(body) + +replace the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceIngressClassRequest = { + // name of the IngressClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controller: "controller_example", + parameters: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + scope: "scope_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IngressClass**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1IngressClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedIngress + + + +> V1Ingress replaceNamespacedIngress(body) + +replace the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedIngressStatus + + + +> V1Ingress replaceNamespacedIngressStatus(body) + +replace status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceNamespacedIngressStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedNetworkPolicy + + + +> V1NetworkPolicy replaceNamespacedNetworkPolicy(body) + +replace the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + egress: [ + { + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + to: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + }, + ], + ingress: [ + { + _from: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + }, + ], + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + policyTypes: [ + "policyTypes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1NetworkPolicy**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceServiceCIDR + + + +> V1ServiceCIDR replaceServiceCIDR(body) + +replace the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceServiceCIDRStatus + + + +> V1ServiceCIDR replaceServiceCIDRStatus(body) + +replace status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/networking/NetworkingV1beta1Api.md b/website/docs/api-reference/networking/NetworkingV1beta1Api.md new file mode 100644 index 00000000000..f14ea0a610c --- /dev/null +++ b/website/docs/api-reference/networking/NetworkingV1beta1Api.md @@ -0,0 +1,1675 @@ +--- +id: NetworkingV1beta1Api +title: NetworkingV1beta1Api +sidebar_label: NetworkingV1beta1Api +sidebar_position: 5 +--- +# NetworkingV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#createIPAddress) | **POST** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**createServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**deleteCollectionIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**deleteCollectionServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**deleteIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**deleteServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**getAPIResources**](/docs/api-reference/networking/NetworkingV1beta1Api#getAPIResources) | **GET** /apis/networking.k8s.io/v1beta1/ | +[**listIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#listIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**listServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**patchIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**patchServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**patchServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | +[**readIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#readIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**readServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**readServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | +[**replaceIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**replaceServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**replaceServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | + +### createIPAddress + + + +> V1beta1IPAddress createIPAddress(body) + +create an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiCreateIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiCreateIPAddressRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1IPAddress**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createServiceCIDR + + + +> V1beta1ServiceCIDR createServiceCIDR(body) + +create a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiCreateServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiCreateServiceCIDRRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionIPAddress + + + +> V1Status deleteCollectionIPAddress() + +delete collection of IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiDeleteCollectionIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteCollectionIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionServiceCIDR + + + +> V1Status deleteCollectionServiceCIDR() + +delete collection of ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteIPAddress + + + +> V1Status deleteIPAddress() + +delete an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiDeleteIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteServiceCIDR + + + +> V1Status deleteServiceCIDR() + +delete a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiDeleteServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listIPAddress + + + +> V1beta1IPAddressList listIPAddress() + +list or watch objects of kind IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiListIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiListIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1IPAddressList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listServiceCIDR + + + +> V1beta1ServiceCIDRList listServiceCIDR() + +list or watch objects of kind ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiListServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiListServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDRList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchIPAddress + + + +> V1beta1IPAddress patchIPAddress(body) + +partially update the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiPatchIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchServiceCIDR + + + +> V1beta1ServiceCIDR patchServiceCIDR(body) + +partially update the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiPatchServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchServiceCIDRStatus + + + +> V1beta1ServiceCIDR patchServiceCIDRStatus(body) + +partially update status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiPatchServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readIPAddress + + + +> V1beta1IPAddress readIPAddress() + +read the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReadIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readServiceCIDR + + + +> V1beta1ServiceCIDR readServiceCIDR() + +read the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReadServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readServiceCIDRStatus + + + +> V1beta1ServiceCIDR readServiceCIDRStatus() + +read status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReadServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceIPAddress + + + +> V1beta1IPAddress replaceIPAddress(body) + +replace the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReplaceIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1IPAddress**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceServiceCIDR + + + +> V1beta1ServiceCIDR replaceServiceCIDR(body) + +replace the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReplaceServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceServiceCIDRStatus + + + +> V1beta1ServiceCIDR replaceServiceCIDRStatus(body) + +replace status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/networking/_category_.json b/website/docs/api-reference/networking/_category_.json new file mode 100644 index 00000000000..c1c4f2787e3 --- /dev/null +++ b/website/docs/api-reference/networking/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Networking", + "position": 3 +} diff --git a/website/docs/api-reference/other/ApisApi.md b/website/docs/api-reference/other/ApisApi.md new file mode 100644 index 00000000000..966043d77e2 --- /dev/null +++ b/website/docs/api-reference/other/ApisApi.md @@ -0,0 +1,62 @@ +--- +id: ApisApi +title: ApisApi +sidebar_label: ApisApi +sidebar_position: 1 +--- +# ApisApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIVersions**](/docs/api-reference/other/ApisApi#getAPIVersions) | **GET** /apis/ | + +### getAPIVersions + + + +> V1APIGroupList getAPIVersions() + +get available API versions + +### Example + + +```typescript +import { createConfiguration, ApisApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApisApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIVersions(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroupList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/AutoscalingApi.md b/website/docs/api-reference/other/AutoscalingApi.md new file mode 100644 index 00000000000..55b0e1d62ba --- /dev/null +++ b/website/docs/api-reference/other/AutoscalingApi.md @@ -0,0 +1,62 @@ +--- +id: AutoscalingApi +title: AutoscalingApi +sidebar_label: AutoscalingApi +sidebar_position: 2 +--- +# AutoscalingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/other/AutoscalingApi#getAPIGroup) | **GET** /apis/autoscaling/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AutoscalingApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/AutoscalingV1Api.md b/website/docs/api-reference/other/AutoscalingV1Api.md new file mode 100644 index 00000000000..0b0e3e3b682 --- /dev/null +++ b/website/docs/api-reference/other/AutoscalingV1Api.md @@ -0,0 +1,1125 @@ +--- +id: AutoscalingV1Api +title: AutoscalingV1Api +sidebar_label: AutoscalingV1Api +sidebar_position: 3 +--- +# AutoscalingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteCollectionNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**getAPIResources**](/docs/api-reference/other/AutoscalingV1Api#getAPIResources) | **GET** /apis/autoscaling/v1/ | +[**listHorizontalPodAutoscalerForAllNamespaces**](/docs/api-reference/other/AutoscalingV1Api#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v1/horizontalpodautoscalers | +[**listNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**patchNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**patchNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**readNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**readNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**replaceNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**replaceNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | + +### createNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) + +create a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedHorizontalPodAutoscaler + + + +> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() + +delete collection of HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedHorizontalPodAutoscaler + + + +> V1Status deleteNamespacedHorizontalPodAutoscaler() + +delete a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listHorizontalPodAutoscalerForAllNamespaces + + + +> V1HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscalerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscalerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) + +partially update the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedHorizontalPodAutoscalerStatus + + + +> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) + +partially update status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() + +read the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedHorizontalPodAutoscalerStatus + + + +> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() + +read status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) + +replace the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedHorizontalPodAutoscalerStatus + + + +> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) + +replace status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/AutoscalingV2Api.md b/website/docs/api-reference/other/AutoscalingV2Api.md new file mode 100644 index 00000000000..95197559ac4 --- /dev/null +++ b/website/docs/api-reference/other/AutoscalingV2Api.md @@ -0,0 +1,1833 @@ +--- +id: AutoscalingV2Api +title: AutoscalingV2Api +sidebar_label: AutoscalingV2Api +sidebar_position: 4 +--- +# AutoscalingV2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteCollectionNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**getAPIResources**](/docs/api-reference/other/AutoscalingV2Api#getAPIResources) | **GET** /apis/autoscaling/v2/ | +[**listHorizontalPodAutoscalerForAllNamespaces**](/docs/api-reference/other/AutoscalingV2Api#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v2/horizontalpodautoscalers | +[**listNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**patchNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**patchNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**readNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**readNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**replaceNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**replaceNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | + +### createNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) + +create a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedHorizontalPodAutoscaler + + + +> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() + +delete collection of HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedHorizontalPodAutoscaler + + + +> V1Status deleteNamespacedHorizontalPodAutoscaler() + +delete a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listHorizontalPodAutoscalerForAllNamespaces + + + +> V2HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscalerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscalerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) + +partially update the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedHorizontalPodAutoscalerStatus + + + +> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) + +partially update status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() + +read the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedHorizontalPodAutoscalerStatus + + + +> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() + +read status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) + +replace the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedHorizontalPodAutoscalerStatus + + + +> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) + +replace status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/CustomObjectsApi.md b/website/docs/api-reference/other/CustomObjectsApi.md new file mode 100644 index 00000000000..7b1af985aa2 --- /dev/null +++ b/website/docs/api-reference/other/CustomObjectsApi.md @@ -0,0 +1,2234 @@ +--- +id: CustomObjectsApi +title: CustomObjectsApi +sidebar_label: CustomObjectsApi +sidebar_position: 5 +--- +# CustomObjectsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#createClusterCustomObject) | **POST** /apis/{group}/{version}/{plural} | +[**createNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#createNamespacedCustomObject) | **POST** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**deleteClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural}/{name} | +[**deleteCollectionClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteCollectionClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural} | +[**deleteCollectionNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteCollectionNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**deleteNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**getAPIResources**](/docs/api-reference/other/CustomObjectsApi#getAPIResources) | **GET** /apis/{group}/{version} | +[**getClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObject) | **GET** /apis/{group}/{version}/{plural}/{name} | +[**getClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObjectScale) | **GET** /apis/{group}/{version}/{plural}/{name}/scale | +[**getClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObjectStatus) | **GET** /apis/{group}/{version}/{plural}/{name}/status | +[**getNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**getNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObjectScale) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**getNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObjectStatus) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | +[**listClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#listClusterCustomObject) | **GET** /apis/{group}/{version}/{plural} | +[**listCustomObjectForAllNamespaces**](/docs/api-reference/other/CustomObjectsApi#listCustomObjectForAllNamespaces) | **GET** /apis/{group}/{version}/{resource_plural} | +[**listNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#listNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**patchClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObject) | **PATCH** /apis/{group}/{version}/{plural}/{name} | +[**patchClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObjectScale) | **PATCH** /apis/{group}/{version}/{plural}/{name}/scale | +[**patchClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObjectStatus) | **PATCH** /apis/{group}/{version}/{plural}/{name}/status | +[**patchNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObject) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**patchNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObjectScale) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**patchNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObjectStatus) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | +[**replaceClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObject) | **PUT** /apis/{group}/{version}/{plural}/{name} | +[**replaceClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObjectScale) | **PUT** /apis/{group}/{version}/{plural}/{name}/scale | +[**replaceClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObjectStatus) | **PUT** /apis/{group}/{version}/{plural}/{name}/status | +[**replaceNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObject) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**replaceNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObjectScale) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**replaceNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObjectStatus) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | + +### createClusterCustomObject + + + +> any createClusterCustomObject(body) + +Creates a cluster scoped Custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiCreateClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiCreateClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // The JSON schema of the Resource to create. + body: {}, + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to create. | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**401** | Unauthorized | - | + +### createNamespacedCustomObject + + + +> any createNamespacedCustomObject(body) + +Creates a namespace scoped Custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiCreateNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiCreateNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // The JSON schema of the Resource to create. + body: {}, + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to create. | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**401** | Unauthorized | - | + +### deleteClusterCustomObject + + + +> any deleteClusterCustomObject() + +Deletes the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiDeleteClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterCustomObject + + + +> any deleteCollectionClusterCustomObject() + +Delete collection of cluster scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiDeleteCollectionClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteCollectionClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedCustomObject + + + +> any deleteCollectionNamespacedCustomObject() + +Delete collection of namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedCustomObject + + + +> any deleteNamespacedCustomObject() + +Deletes the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiDeleteNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetAPIResourcesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetAPIResourcesRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", +}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getClusterCustomObject + + + +> any getClusterCustomObject() + +Returns a cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A single Resource | - | +**401** | Unauthorized | - | + +### getClusterCustomObjectScale + + + +> any getClusterCustomObjectScale() + +read scale of the specified custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getClusterCustomObjectStatus + + + +> any getClusterCustomObjectStatus() + +read status of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getNamespacedCustomObject + + + +> any getNamespacedCustomObject() + +Returns a namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A single Resource | - | +**401** | Unauthorized | - | + +### getNamespacedCustomObjectScale + + + +> any getNamespacedCustomObjectScale() + +read scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getNamespacedCustomObjectStatus + + + +> any getNamespacedCustomObjectStatus() + +read status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterCustomObject + + + +> any listClusterCustomObject() + +list or watch cluster scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiListClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCustomObjectForAllNamespaces + + + +> any listCustomObjectForAllNamespaces() + +list or watch namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiListCustomObjectForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListCustomObjectForAllNamespacesRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + resourcePlural: "resource_plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listCustomObjectForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **resourcePlural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedCustomObject + + + +> any listNamespacedCustomObject() + +list or watch namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiListNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterCustomObject + + + +> any patchClusterCustomObject(body) + +patch the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to patch. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to patch. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterCustomObjectScale + + + +> any patchClusterCustomObjectScale(body) + +partially update scale of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterCustomObjectStatus + + + +> any patchClusterCustomObjectStatus(body) + +partially update status of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedCustomObject + + + +> any patchNamespacedCustomObject(body) + +patch the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to patch. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to patch. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedCustomObjectScale + + + +> any patchNamespacedCustomObjectScale(body) + +partially update scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedCustomObjectStatus + + + +> any patchNamespacedCustomObjectStatus(body) + +partially update status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterCustomObject + + + +> any replaceClusterCustomObject(body) + +replace the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to replace. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to replace. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterCustomObjectScale + + + +> any replaceClusterCustomObjectScale(body) + +replace scale of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceClusterCustomObjectStatus + + + +> any replaceClusterCustomObjectStatus(body) + +replace status of the cluster scoped specified custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedCustomObject + + + +> any replaceNamespacedCustomObject(body) + +replace the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to replace. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to replace. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedCustomObjectScale + + + +> any replaceNamespacedCustomObjectScale(body) + +replace scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedCustomObjectStatus + + + +> any replaceNamespacedCustomObjectStatus(body) + +replace status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/FlowcontrolApiserverApi.md b/website/docs/api-reference/other/FlowcontrolApiserverApi.md new file mode 100644 index 00000000000..41a4b06ea22 --- /dev/null +++ b/website/docs/api-reference/other/FlowcontrolApiserverApi.md @@ -0,0 +1,62 @@ +--- +id: FlowcontrolApiserverApi +title: FlowcontrolApiserverApi +sidebar_label: FlowcontrolApiserverApi +sidebar_position: 6 +--- +# FlowcontrolApiserverApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/other/FlowcontrolApiserverApi#getAPIGroup) | **GET** /apis/flowcontrol.apiserver.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/FlowcontrolApiserverV1Api.md b/website/docs/api-reference/other/FlowcontrolApiserverV1Api.md new file mode 100644 index 00000000000..e4a02865c2d --- /dev/null +++ b/website/docs/api-reference/other/FlowcontrolApiserverV1Api.md @@ -0,0 +1,2147 @@ +--- +id: FlowcontrolApiserverV1Api +title: FlowcontrolApiserverV1Api +sidebar_label: FlowcontrolApiserverV1Api +sidebar_position: 7 +--- +# FlowcontrolApiserverV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#createFlowSchema) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**createPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#createPriorityLevelConfiguration) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**deleteCollectionFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteCollectionFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**deleteCollectionPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteCollectionPriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**deleteFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**deletePriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deletePriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**getAPIResources**](/docs/api-reference/other/FlowcontrolApiserverV1Api#getAPIResources) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/ | +[**listFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#listFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**listPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#listPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**patchFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchFlowSchema) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**patchFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchFlowSchemaStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**patchPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchPriorityLevelConfiguration) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**patchPriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchPriorityLevelConfigurationStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | +[**readFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**readFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readFlowSchemaStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**readPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**readPriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readPriorityLevelConfigurationStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | +[**replaceFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replaceFlowSchema) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**replaceFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replaceFlowSchemaStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**replacePriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replacePriorityLevelConfiguration) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**replacePriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replacePriorityLevelConfigurationStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | + +### createFlowSchema + + + +> V1FlowSchema createFlowSchema(body) + +create a FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiCreateFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiCreateFlowSchemaRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createPriorityLevelConfiguration + + + +> V1PriorityLevelConfiguration createPriorityLevelConfiguration(body) + +create a PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionFlowSchema + + + +> V1Status deleteCollectionFlowSchema() + +delete collection of FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionPriorityLevelConfiguration + + + +> V1Status deleteCollectionPriorityLevelConfiguration() + +delete collection of PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteFlowSchema + + + +> V1Status deleteFlowSchema() + +delete a FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deletePriorityLevelConfiguration + + + +> V1Status deletePriorityLevelConfiguration() + +delete a PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listFlowSchema + + + +> V1FlowSchemaList listFlowSchema() + +list or watch objects of kind FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiListFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiListFlowSchemaRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1FlowSchemaList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPriorityLevelConfiguration + + + +> V1PriorityLevelConfigurationList listPriorityLevelConfiguration() + +list or watch objects of kind PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfigurationList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchFlowSchema + + + +> V1FlowSchema patchFlowSchema(body) + +partially update the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiPatchFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchFlowSchemaStatus + + + +> V1FlowSchema patchFlowSchemaStatus(body) + +partially update status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchPriorityLevelConfiguration + + + +> V1PriorityLevelConfiguration patchPriorityLevelConfiguration(body) + +partially update the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchPriorityLevelConfigurationStatus + + + +> V1PriorityLevelConfiguration patchPriorityLevelConfigurationStatus(body) + +partially update status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readFlowSchema + + + +> V1FlowSchema readFlowSchema() + +read the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReadFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readFlowSchemaStatus + + + +> V1FlowSchema readFlowSchemaStatus() + +read status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readPriorityLevelConfiguration + + + +> V1PriorityLevelConfiguration readPriorityLevelConfiguration() + +read the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readPriorityLevelConfigurationStatus + + + +> V1PriorityLevelConfiguration readPriorityLevelConfigurationStatus() + +read status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceFlowSchema + + + +> V1FlowSchema replaceFlowSchema(body) + +replace the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceFlowSchemaStatus + + + +> V1FlowSchema replaceFlowSchemaStatus(body) + +replace status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replacePriorityLevelConfiguration + + + +> V1PriorityLevelConfiguration replacePriorityLevelConfiguration(body) + +replace the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replacePriorityLevelConfigurationStatus + + + +> V1PriorityLevelConfiguration replacePriorityLevelConfigurationStatus(body) + +replace status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/InternalApiserverApi.md b/website/docs/api-reference/other/InternalApiserverApi.md new file mode 100644 index 00000000000..004c2a11502 --- /dev/null +++ b/website/docs/api-reference/other/InternalApiserverApi.md @@ -0,0 +1,62 @@ +--- +id: InternalApiserverApi +title: InternalApiserverApi +sidebar_label: InternalApiserverApi +sidebar_position: 8 +--- +# InternalApiserverApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/other/InternalApiserverApi#getAPIGroup) | **GET** /apis/internal.apiserver.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, InternalApiserverApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/InternalApiserverV1alpha1Api.md b/website/docs/api-reference/other/InternalApiserverV1alpha1Api.md new file mode 100644 index 00000000000..dad0d5fc68c --- /dev/null +++ b/website/docs/api-reference/other/InternalApiserverV1alpha1Api.md @@ -0,0 +1,1037 @@ +--- +id: InternalApiserverV1alpha1Api +title: InternalApiserverV1alpha1Api +sidebar_label: InternalApiserverV1alpha1Api +sidebar_position: 9 +--- +# InternalApiserverV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#createStorageVersion) | **POST** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**deleteCollectionStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#deleteCollectionStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**deleteStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#deleteStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**getAPIResources**](/docs/api-reference/other/InternalApiserverV1alpha1Api#getAPIResources) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/ | +[**listStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#listStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**patchStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#patchStorageVersion) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**patchStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#patchStorageVersionStatus) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | +[**readStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#readStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**readStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#readStorageVersionStatus) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | +[**replaceStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#replaceStorageVersion) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**replaceStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#replaceStorageVersionStatus) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | + +### createStorageVersion + + + +> V1alpha1StorageVersion createStorageVersion(body) + +create a StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiCreateStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiCreateStorageVersionRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionStorageVersion + + + +> V1Status deleteCollectionStorageVersion() + +delete collection of StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteStorageVersion + + + +> V1Status deleteStorageVersion() + +delete a StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiDeleteStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiDeleteStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listStorageVersion + + + +> V1alpha1StorageVersionList listStorageVersion() + +list or watch objects of kind StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiListStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiListStorageVersionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersionList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchStorageVersion + + + +> V1alpha1StorageVersion patchStorageVersion(body) + +partially update the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiPatchStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiPatchStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchStorageVersionStatus + + + +> V1alpha1StorageVersion patchStorageVersionStatus(body) + +partially update status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readStorageVersion + + + +> V1alpha1StorageVersion readStorageVersion() + +read the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiReadStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReadStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readStorageVersionStatus + + + +> V1alpha1StorageVersion readStorageVersionStatus() + +read status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceStorageVersion + + + +> V1alpha1StorageVersion replaceStorageVersion(body) + +replace the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiReplaceStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReplaceStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceStorageVersionStatus + + + +> V1alpha1StorageVersion replaceStorageVersionStatus(body) + +replace status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/LogsApi.md b/website/docs/api-reference/other/LogsApi.md new file mode 100644 index 00000000000..6b4953a3eea --- /dev/null +++ b/website/docs/api-reference/other/LogsApi.md @@ -0,0 +1,111 @@ +--- +id: LogsApi +title: LogsApi +sidebar_label: LogsApi +sidebar_position: 10 +--- +# LogsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**logFileHandler**](/docs/api-reference/other/LogsApi#logFileHandler) | **GET** /logs/{logpath} | +[**logFileListHandler**](/docs/api-reference/other/LogsApi#logFileListHandler) | **GET** /logs/ | + +### logFileHandler + + + +> logFileHandler() + +### Example + + +```typescript +import { createConfiguration, LogsApi } from '@kubernetes/client-node'; +import type { LogsApiLogFileHandlerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new LogsApi(configuration); + +const request: LogsApiLogFileHandlerRequest = { + // path to the log + logpath: "logpath_example", +}; + +const data = await apiInstance.logFileHandler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **logpath** | [**string**] | path to the log | defaults to undefined + +### Return type + +void (empty response body) + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**401** | Unauthorized | - | + +### logFileListHandler + + + +> logFileListHandler() + +### Example + + +```typescript +import { createConfiguration, LogsApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new LogsApi(configuration); + +const request = {}; + +const data = await apiInstance.logFileListHandler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/OpenidApi.md b/website/docs/api-reference/other/OpenidApi.md new file mode 100644 index 00000000000..7c54bab7421 --- /dev/null +++ b/website/docs/api-reference/other/OpenidApi.md @@ -0,0 +1,62 @@ +--- +id: OpenidApi +title: OpenidApi +sidebar_label: OpenidApi +sidebar_position: 11 +--- +# OpenidApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getServiceAccountIssuerOpenIDKeyset**](/docs/api-reference/other/OpenidApi#getServiceAccountIssuerOpenIDKeyset) | **GET** /openid/v1/jwks | + +### getServiceAccountIssuerOpenIDKeyset + + + +> string getServiceAccountIssuerOpenIDKeyset() + +get service account issuer OpenID JSON Web Key Set (contains public token verification keys) + +### Example + + +```typescript +import { createConfiguration, OpenidApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new OpenidApi(configuration); + +const request = {}; + +const data = await apiInstance.getServiceAccountIssuerOpenIDKeyset(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/jwk-set+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/ResourceApi.md b/website/docs/api-reference/other/ResourceApi.md new file mode 100644 index 00000000000..4f03d6331c3 --- /dev/null +++ b/website/docs/api-reference/other/ResourceApi.md @@ -0,0 +1,62 @@ +--- +id: ResourceApi +title: ResourceApi +sidebar_label: ResourceApi +sidebar_position: 12 +--- +# ResourceApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/other/ResourceApi#getAPIGroup) | **GET** /apis/resource.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ResourceApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/ResourceV1Api.md b/website/docs/api-reference/other/ResourceV1Api.md new file mode 100644 index 00000000000..f5608ee68dc --- /dev/null +++ b/website/docs/api-reference/other/ResourceV1Api.md @@ -0,0 +1,4243 @@ +--- +id: ResourceV1Api +title: ResourceV1Api +sidebar_label: ResourceV1Api +sidebar_position: 14 +--- +# ResourceV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](/docs/api-reference/other/ResourceV1Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1/deviceclasses | +[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](/docs/api-reference/other/ResourceV1Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1/resourceslices | +[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices | +[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**getAPIResources**](/docs/api-reference/other/ResourceV1Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1/ | +[**listDeviceClass**](/docs/api-reference/other/ResourceV1Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses | +[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaimtemplates | +[**listResourceSlice**](/docs/api-reference/other/ResourceV1Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices | +[**patchDeviceClass**](/docs/api-reference/other/ResourceV1Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](/docs/api-reference/other/ResourceV1Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**readDeviceClass**](/docs/api-reference/other/ResourceV1Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](/docs/api-reference/other/ResourceV1Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1/resourceslices/{name} | + +### createDeviceClass + + + +> V1DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaim + + + +> ResourceV1ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createResourceSlice + + + +> V1ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionDeviceClass + + + +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaim + + + +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaimTemplate + + + +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionResourceSlice + + + +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteDeviceClass + + + +> V1DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaim + + + +> ResourceV1ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteResourceSlice + + + +> V1ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeviceClass + + + +> V1DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DeviceClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaim + + + +> V1ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimForAllNamespaces + + + +> V1ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimTemplateForAllNamespaces + + + +> V1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceSlice + + + +> V1ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchDeviceClass + + + +> V1DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaim + + + +> ResourceV1ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimStatus + + + +> ResourceV1ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchResourceSlice + + + +> V1ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readDeviceClass + + + +> V1DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaim + + + +> ResourceV1ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimStatus + + + +> ResourceV1ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readResourceSlice + + + +> V1ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceDeviceClass + + + +> V1DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaim + + + +> ResourceV1ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimStatus + + + +> ResourceV1ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceResourceSlice + + + +> V1ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/ResourceV1alpha3Api.md b/website/docs/api-reference/other/ResourceV1alpha3Api.md new file mode 100644 index 00000000000..422afac65e5 --- /dev/null +++ b/website/docs/api-reference/other/ResourceV1alpha3Api.md @@ -0,0 +1,1034 @@ +--- +id: ResourceV1alpha3Api +title: ResourceV1alpha3Api +sidebar_label: ResourceV1alpha3Api +sidebar_position: 13 +--- +# ResourceV1alpha3Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#createDeviceTaintRule) | **POST** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**deleteCollectionDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#deleteCollectionDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**deleteDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#deleteDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**getAPIResources**](/docs/api-reference/other/ResourceV1alpha3Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1alpha3/ | +[**listDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#listDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**patchDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#patchDeviceTaintRule) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**patchDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#patchDeviceTaintRuleStatus) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | +[**readDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#readDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**readDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#readDeviceTaintRuleStatus) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | +[**replaceDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#replaceDeviceTaintRule) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**replaceDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#replaceDeviceTaintRuleStatus) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | + +### createDeviceTaintRule + + + +> V1alpha3DeviceTaintRule createDeviceTaintRule(body) + +create a DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiCreateDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiCreateDeviceTaintRuleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionDeviceTaintRule + + + +> V1Status deleteCollectionDeviceTaintRule() + +delete collection of DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteDeviceTaintRule + + + +> V1alpha3DeviceTaintRule deleteDeviceTaintRule() + +delete a DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeviceTaintRule + + + +> V1alpha3DeviceTaintRuleList listDeviceTaintRule() + +list or watch objects of kind DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiListDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiListDeviceTaintRuleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRuleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchDeviceTaintRule + + + +> V1alpha3DeviceTaintRule patchDeviceTaintRule(body) + +partially update the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiPatchDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiPatchDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchDeviceTaintRuleStatus + + + +> V1alpha3DeviceTaintRule patchDeviceTaintRuleStatus(body) + +partially update status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readDeviceTaintRule + + + +> V1alpha3DeviceTaintRule readDeviceTaintRule() + +read the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiReadDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReadDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readDeviceTaintRuleStatus + + + +> V1alpha3DeviceTaintRule readDeviceTaintRuleStatus() + +read status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceDeviceTaintRule + + + +> V1alpha3DeviceTaintRule replaceDeviceTaintRule(body) + +replace the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceDeviceTaintRuleStatus + + + +> V1alpha3DeviceTaintRule replaceDeviceTaintRuleStatus(body) + +replace status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/ResourceV1beta1Api.md b/website/docs/api-reference/other/ResourceV1beta1Api.md new file mode 100644 index 00000000000..45b5addc503 --- /dev/null +++ b/website/docs/api-reference/other/ResourceV1beta1Api.md @@ -0,0 +1,4237 @@ +--- +id: ResourceV1beta1Api +title: ResourceV1beta1Api +sidebar_label: ResourceV1beta1Api +sidebar_position: 15 +--- +# ResourceV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta1/resourceslices | +[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices | +[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**getAPIResources**](/docs/api-reference/other/ResourceV1beta1Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta1/ | +[**listDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1beta1Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1beta1Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaimtemplates | +[**listResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices | +[**patchDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**readDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | + +### createDeviceClass + + + +> V1beta1DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaim + + + +> V1beta1ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createResourceSlice + + + +> V1beta1ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + basic: { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + name: "name_example", + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionDeviceClass + + + +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaim + + + +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaimTemplate + + + +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionResourceSlice + + + +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteDeviceClass + + + +> V1beta1DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaim + + + +> V1beta1ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteResourceSlice + + + +> V1beta1ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeviceClass + + + +> V1beta1DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaim + + + +> V1beta1ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimForAllNamespaces + + + +> V1beta1ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimTemplateForAllNamespaces + + + +> V1beta1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceSlice + + + +> V1beta1ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchDeviceClass + + + +> V1beta1DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaim + + + +> V1beta1ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimStatus + + + +> V1beta1ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchResourceSlice + + + +> V1beta1ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readDeviceClass + + + +> V1beta1DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaim + + + +> V1beta1ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimStatus + + + +> V1beta1ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readResourceSlice + + + +> V1beta1ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceDeviceClass + + + +> V1beta1DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaim + + + +> V1beta1ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimStatus + + + +> V1beta1ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceResourceSlice + + + +> V1beta1ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + basic: { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + name: "name_example", + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/ResourceV1beta2Api.md b/website/docs/api-reference/other/ResourceV1beta2Api.md new file mode 100644 index 00000000000..63718ec328b --- /dev/null +++ b/website/docs/api-reference/other/ResourceV1beta2Api.md @@ -0,0 +1,4243 @@ +--- +id: ResourceV1beta2Api +title: ResourceV1beta2Api +sidebar_label: ResourceV1beta2Api +sidebar_position: 16 +--- +# ResourceV1beta2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta2/resourceslices | +[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices | +[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**getAPIResources**](/docs/api-reference/other/ResourceV1beta2Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta2/ | +[**listDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1beta2Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1beta2Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaimtemplates | +[**listResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices | +[**patchDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**readDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | + +### createDeviceClass + + + +> V1beta2DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaim + + + +> V1beta2ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createResourceSlice + + + +> V1beta2ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionDeviceClass + + + +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaim + + + +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaimTemplate + + + +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionResourceSlice + + + +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteDeviceClass + + + +> V1beta2DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaim + + + +> V1beta2ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteResourceSlice + + + +> V1beta2ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeviceClass + + + +> V1beta2DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaim + + + +> V1beta2ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimForAllNamespaces + + + +> V1beta2ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimTemplateForAllNamespaces + + + +> V1beta2ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceSlice + + + +> V1beta2ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchDeviceClass + + + +> V1beta2DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaim + + + +> V1beta2ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimStatus + + + +> V1beta2ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchResourceSlice + + + +> V1beta2ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readDeviceClass + + + +> V1beta2DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaim + + + +> V1beta2ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimStatus + + + +> V1beta2ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readResourceSlice + + + +> V1beta2ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceDeviceClass + + + +> V1beta2DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaim + + + +> V1beta2ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimStatus + + + +> V1beta2ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceResourceSlice + + + +> V1beta2ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/VersionApi.md b/website/docs/api-reference/other/VersionApi.md new file mode 100644 index 00000000000..4bcec0125a1 --- /dev/null +++ b/website/docs/api-reference/other/VersionApi.md @@ -0,0 +1,62 @@ +--- +id: VersionApi +title: VersionApi +sidebar_label: VersionApi +sidebar_position: 17 +--- +# VersionApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getCode**](/docs/api-reference/other/VersionApi#getCode) | **GET** /version/ | + +### getCode + + + +> VersionInfo getCode() + +get the version information for this server + +### Example + + +```typescript +import { createConfiguration, VersionApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new VersionApi(configuration); + +const request = {}; + +const data = await apiInstance.getCode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +VersionInfo + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/WellKnownApi.md b/website/docs/api-reference/other/WellKnownApi.md new file mode 100644 index 00000000000..e3550313146 --- /dev/null +++ b/website/docs/api-reference/other/WellKnownApi.md @@ -0,0 +1,62 @@ +--- +id: WellKnownApi +title: WellKnownApi +sidebar_label: WellKnownApi +sidebar_position: 18 +--- +# WellKnownApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getServiceAccountIssuerOpenIDConfiguration**](/docs/api-reference/other/WellKnownApi#getServiceAccountIssuerOpenIDConfiguration) | **GET** /.well-known/openid-configuration | + +### getServiceAccountIssuerOpenIDConfiguration + + + +> string getServiceAccountIssuerOpenIDConfiguration() + +get service account issuer OpenID configuration, also known as the \'OIDC discovery doc\' + +### Example + + +```typescript +import { createConfiguration, WellKnownApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new WellKnownApi(configuration); + +const request = {}; + +const data = await apiInstance.getServiceAccountIssuerOpenIDConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/other/_category_.json b/website/docs/api-reference/other/_category_.json new file mode 100644 index 00000000000..ea3276e897e --- /dev/null +++ b/website/docs/api-reference/other/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Other", + "position": 7 +} diff --git a/website/docs/api-reference/security/AuthenticationApi.md b/website/docs/api-reference/security/AuthenticationApi.md new file mode 100644 index 00000000000..87462a1c002 --- /dev/null +++ b/website/docs/api-reference/security/AuthenticationApi.md @@ -0,0 +1,62 @@ +--- +id: AuthenticationApi +title: AuthenticationApi +sidebar_label: AuthenticationApi +sidebar_position: 1 +--- +# AuthenticationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/security/AuthenticationApi#getAPIGroup) | **GET** /apis/authentication.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AuthenticationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/AuthenticationV1Api.md b/website/docs/api-reference/security/AuthenticationV1Api.md new file mode 100644 index 00000000000..ea08df6db06 --- /dev/null +++ b/website/docs/api-reference/security/AuthenticationV1Api.md @@ -0,0 +1,329 @@ +--- +id: AuthenticationV1Api +title: AuthenticationV1Api +sidebar_label: AuthenticationV1Api +sidebar_position: 2 +--- +# AuthenticationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createSelfSubjectReview**](/docs/api-reference/security/AuthenticationV1Api#createSelfSubjectReview) | **POST** /apis/authentication.k8s.io/v1/selfsubjectreviews | +[**createTokenReview**](/docs/api-reference/security/AuthenticationV1Api#createTokenReview) | **POST** /apis/authentication.k8s.io/v1/tokenreviews | +[**getAPIResources**](/docs/api-reference/security/AuthenticationV1Api#getAPIResources) | **GET** /apis/authentication.k8s.io/v1/ | + +### createSelfSubjectReview + + + +> V1SelfSubjectReview createSelfSubjectReview(body) + +create a SelfSubjectReview + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; +import type { AuthenticationV1ApiCreateSelfSubjectReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request: AuthenticationV1ApiCreateSelfSubjectReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + status: { + userInfo: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + uid: "uid_example", + username: "username_example", + }, + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1SelfSubjectReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createTokenReview + + + +> V1TokenReview createTokenReview(body) + +create a TokenReview + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; +import type { AuthenticationV1ApiCreateTokenReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request: AuthenticationV1ApiCreateTokenReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + audiences: [ + "audiences_example", + ], + token: "token_example", + }, + status: { + audiences: [ + "audiences_example", + ], + authenticated: true, + error: "error_example", + user: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + uid: "uid_example", + username: "username_example", + }, + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createTokenReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1TokenReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1TokenReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/AuthorizationApi.md b/website/docs/api-reference/security/AuthorizationApi.md new file mode 100644 index 00000000000..8a455c1507a --- /dev/null +++ b/website/docs/api-reference/security/AuthorizationApi.md @@ -0,0 +1,62 @@ +--- +id: AuthorizationApi +title: AuthorizationApi +sidebar_label: AuthorizationApi +sidebar_position: 3 +--- +# AuthorizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/security/AuthorizationApi#getAPIGroup) | **GET** /apis/authorization.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AuthorizationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/AuthorizationV1Api.md b/website/docs/api-reference/security/AuthorizationV1Api.md new file mode 100644 index 00000000000..f93a906688b --- /dev/null +++ b/website/docs/api-reference/security/AuthorizationV1Api.md @@ -0,0 +1,709 @@ +--- +id: AuthorizationV1Api +title: AuthorizationV1Api +sidebar_label: AuthorizationV1Api +sidebar_position: 4 +--- +# AuthorizationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLocalSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createNamespacedLocalSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews | +[**createSelfSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createSelfSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectaccessreviews | +[**createSelfSubjectRulesReview**](/docs/api-reference/security/AuthorizationV1Api#createSelfSubjectRulesReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectrulesreviews | +[**createSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/subjectaccessreviews | +[**getAPIResources**](/docs/api-reference/security/AuthorizationV1Api#getAPIResources) | **GET** /apis/authorization.k8s.io/v1/ | + +### createNamespacedLocalSubjectAccessReview + + + +> V1LocalSubjectAccessReview createNamespacedLocalSubjectAccessReview(body) + +create a LocalSubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; +import type { AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + uid: "uid_example", + user: "user_example", + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedLocalSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LocalSubjectAccessReview**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1LocalSubjectAccessReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createSelfSubjectAccessReview + + + +> V1SelfSubjectAccessReview createSelfSubjectAccessReview(body) + +create a SelfSubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; +import type { AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectAccessReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1SelfSubjectAccessReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createSelfSubjectRulesReview + + + +> V1SelfSubjectRulesReview createSelfSubjectRulesReview(body) + +create a SelfSubjectRulesReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; +import type { AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + namespace: "namespace_example", + }, + status: { + evaluationError: "evaluationError_example", + incomplete: true, + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectRulesReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectRulesReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1SelfSubjectRulesReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createSubjectAccessReview + + + +> V1SubjectAccessReview createSubjectAccessReview(body) + +create a SubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; +import type { AuthorizationV1ApiCreateSubjectAccessReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSubjectAccessReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + uid: "uid_example", + user: "user_example", + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SubjectAccessReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1SubjectAccessReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/CertificatesApi.md b/website/docs/api-reference/security/CertificatesApi.md new file mode 100644 index 00000000000..64655347e16 --- /dev/null +++ b/website/docs/api-reference/security/CertificatesApi.md @@ -0,0 +1,62 @@ +--- +id: CertificatesApi +title: CertificatesApi +sidebar_label: CertificatesApi +sidebar_position: 5 +--- +# CertificatesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/security/CertificatesApi#getAPIGroup) | **GET** /apis/certificates.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, CertificatesApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/CertificatesV1Api.md b/website/docs/api-reference/security/CertificatesV1Api.md new file mode 100644 index 00000000000..115c9de03cb --- /dev/null +++ b/website/docs/api-reference/security/CertificatesV1Api.md @@ -0,0 +1,1331 @@ +--- +id: CertificatesV1Api +title: CertificatesV1Api +sidebar_label: CertificatesV1Api +sidebar_position: 7 +--- +# CertificatesV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#createCertificateSigningRequest) | **POST** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**deleteCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#deleteCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**deleteCollectionCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#deleteCollectionCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**getAPIResources**](/docs/api-reference/security/CertificatesV1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1/ | +[**listCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#listCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**patchCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequest) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**patchCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequestApproval) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**patchCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | +[**readCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**readCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequestApproval) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**readCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequestStatus) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | +[**replaceCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequest) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**replaceCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequestApproval) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**replaceCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequestStatus) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | + +### createCertificateSigningRequest + + + +> V1CertificateSigningRequest createCertificateSigningRequest(body) + +create a CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiCreateCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiCreateCertificateSigningRequestRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCertificateSigningRequest + + + +> V1Status deleteCertificateSigningRequest() + +delete a CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiDeleteCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiDeleteCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionCertificateSigningRequest + + + +> V1Status deleteCollectionCertificateSigningRequest() + +delete collection of CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCertificateSigningRequest + + + +> V1CertificateSigningRequestList listCertificateSigningRequest() + +list or watch objects of kind CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiListCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiListCertificateSigningRequestRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequestList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchCertificateSigningRequest + + + +> V1CertificateSigningRequest patchCertificateSigningRequest(body) + +partially update the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiPatchCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchCertificateSigningRequestApproval + + + +> V1CertificateSigningRequest patchCertificateSigningRequestApproval(body) + +partially update approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchCertificateSigningRequestStatus + + + +> V1CertificateSigningRequest patchCertificateSigningRequestStatus(body) + +partially update status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiPatchCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readCertificateSigningRequest + + + +> V1CertificateSigningRequest readCertificateSigningRequest() + +read the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReadCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readCertificateSigningRequestApproval + + + +> V1CertificateSigningRequest readCertificateSigningRequestApproval() + +read approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReadCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readCertificateSigningRequestStatus + + + +> V1CertificateSigningRequest readCertificateSigningRequestStatus() + +read status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReadCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceCertificateSigningRequest + + + +> V1CertificateSigningRequest replaceCertificateSigningRequest(body) + +replace the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReplaceCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceCertificateSigningRequestApproval + + + +> V1CertificateSigningRequest replaceCertificateSigningRequestApproval(body) + +replace approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceCertificateSigningRequestStatus + + + +> V1CertificateSigningRequest replaceCertificateSigningRequestStatus(body) + +replace status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/CertificatesV1alpha1Api.md b/website/docs/api-reference/security/CertificatesV1alpha1Api.md new file mode 100644 index 00000000000..3d8fd7a66b4 --- /dev/null +++ b/website/docs/api-reference/security/CertificatesV1alpha1Api.md @@ -0,0 +1,719 @@ +--- +id: CertificatesV1alpha1Api +title: CertificatesV1alpha1Api +sidebar_label: CertificatesV1alpha1Api +sidebar_position: 6 +--- +# CertificatesV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**deleteClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**deleteCollectionClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**getAPIResources**](/docs/api-reference/security/CertificatesV1alpha1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1alpha1/ | +[**listClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**patchClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**readClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**replaceClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | + +### createClusterTrustBundle + + + +> V1alpha1ClusterTrustBundle createClusterTrustBundle(body) + +create a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiCreateClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiCreateClusterTrustBundleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1ClusterTrustBundle**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteClusterTrustBundle + + + +> V1Status deleteClusterTrustBundle() + +delete a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterTrustBundle + + + +> V1Status deleteCollectionClusterTrustBundle() + +delete collection of ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterTrustBundle + + + +> V1alpha1ClusterTrustBundleList listClusterTrustBundle() + +list or watch objects of kind ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiListClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiListClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterTrustBundle + + + +> V1alpha1ClusterTrustBundle patchClusterTrustBundle(body) + +partially update the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiPatchClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiPatchClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readClusterTrustBundle + + + +> V1alpha1ClusterTrustBundle readClusterTrustBundle() + +read the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiReadClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiReadClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterTrustBundle + + + +> V1alpha1ClusterTrustBundle replaceClusterTrustBundle(body) + +replace the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1ClusterTrustBundle**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/CertificatesV1beta1Api.md b/website/docs/api-reference/security/CertificatesV1beta1Api.md new file mode 100644 index 00000000000..5cef2659fca --- /dev/null +++ b/website/docs/api-reference/security/CertificatesV1beta1Api.md @@ -0,0 +1,1824 @@ +--- +id: CertificatesV1beta1Api +title: CertificatesV1beta1Api +sidebar_label: CertificatesV1beta1Api +sidebar_position: 8 +--- +# CertificatesV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**createNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#createNamespacedPodCertificateRequest) | **POST** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**deleteClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**deleteCollectionClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**deleteCollectionNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#deleteCollectionNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**deleteNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#deleteNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**getAPIResources**](/docs/api-reference/security/CertificatesV1beta1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1beta1/ | +[**listClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**listNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#listNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**listPodCertificateRequestForAllNamespaces**](/docs/api-reference/security/CertificatesV1beta1Api#listPodCertificateRequestForAllNamespaces) | **GET** /apis/certificates.k8s.io/v1beta1/podcertificaterequests | +[**patchClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**patchNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#patchNamespacedPodCertificateRequest) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**patchNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#patchNamespacedPodCertificateRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | +[**readClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**readNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#readNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**readNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#readNamespacedPodCertificateRequestStatus) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | +[**replaceClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**replaceNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#replaceNamespacedPodCertificateRequest) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**replaceNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#replaceNamespacedPodCertificateRequestStatus) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | + +### createClusterTrustBundle + + + +> V1beta1ClusterTrustBundle createClusterTrustBundle(body) + +create a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiCreateClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiCreateClusterTrustBundleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ClusterTrustBundle**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequest createNamespacedPodCertificateRequest(body) + +create a PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteClusterTrustBundle + + + +> V1Status deleteClusterTrustBundle() + +delete a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiDeleteClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterTrustBundle + + + +> V1Status deleteCollectionClusterTrustBundle() + +delete collection of ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPodCertificateRequest + + + +> V1Status deleteCollectionNamespacedPodCertificateRequest() + +delete collection of PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedPodCertificateRequest + + + +> V1Status deleteNamespacedPodCertificateRequest() + +delete a PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterTrustBundle + + + +> V1beta1ClusterTrustBundleList listClusterTrustBundle() + +list or watch objects of kind ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiListClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequestList listNamespacedPodCertificateRequest() + +list or watch objects of kind PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequestList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPodCertificateRequestForAllNamespaces + + + +> V1beta1PodCertificateRequestList listPodCertificateRequestForAllNamespaces() + +list or watch objects of kind PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodCertificateRequestForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequestList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterTrustBundle + + + +> V1beta1ClusterTrustBundle patchClusterTrustBundle(body) + +partially update the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiPatchClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequest(body) + +partially update the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodCertificateRequestStatus + + + +> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequestStatus(body) + +partially update status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readClusterTrustBundle + + + +> V1beta1ClusterTrustBundle readClusterTrustBundle() + +read the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReadClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequest readNamespacedPodCertificateRequest() + +read the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodCertificateRequestStatus + + + +> V1beta1PodCertificateRequest readNamespacedPodCertificateRequestStatus() + +read status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterTrustBundle + + + +> V1beta1ClusterTrustBundle replaceClusterTrustBundle(body) + +replace the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReplaceClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ClusterTrustBundle**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequest(body) + +replace the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodCertificateRequestStatus + + + +> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequestStatus(body) + +replace status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/RbacAuthorizationApi.md b/website/docs/api-reference/security/RbacAuthorizationApi.md new file mode 100644 index 00000000000..02f45f4fa0c --- /dev/null +++ b/website/docs/api-reference/security/RbacAuthorizationApi.md @@ -0,0 +1,62 @@ +--- +id: RbacAuthorizationApi +title: RbacAuthorizationApi +sidebar_label: RbacAuthorizationApi +sidebar_position: 9 +--- +# RbacAuthorizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/security/RbacAuthorizationApi#getAPIGroup) | **GET** /apis/rbac.authorization.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/RbacAuthorizationV1Api.md b/website/docs/api-reference/security/RbacAuthorizationV1Api.md new file mode 100644 index 00000000000..84755290f3d --- /dev/null +++ b/website/docs/api-reference/security/RbacAuthorizationV1Api.md @@ -0,0 +1,3034 @@ +--- +id: RbacAuthorizationV1Api +title: RbacAuthorizationV1Api +sidebar_label: RbacAuthorizationV1Api +sidebar_position: 10 +--- +# RbacAuthorizationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#createClusterRole) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**createClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#createClusterRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**createNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#createNamespacedRole) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**createNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#createNamespacedRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**deleteClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**deleteClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**deleteCollectionClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**deleteCollectionClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**deleteCollectionNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**deleteCollectionNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**deleteNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**deleteNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**getAPIResources**](/docs/api-reference/security/RbacAuthorizationV1Api#getAPIResources) | **GET** /apis/rbac.authorization.k8s.io/v1/ | +[**listClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#listClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**listClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#listClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**listNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#listNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**listNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#listNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**listRoleBindingForAllNamespaces**](/docs/api-reference/security/RbacAuthorizationV1Api#listRoleBindingForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/rolebindings | +[**listRoleForAllNamespaces**](/docs/api-reference/security/RbacAuthorizationV1Api#listRoleForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/roles | +[**patchClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#patchClusterRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**patchClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#patchClusterRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**patchNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#patchNamespacedRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**patchNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#patchNamespacedRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**readClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#readClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**readClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#readClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**readNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#readNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**readNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#readNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**replaceClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceClusterRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**replaceClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceClusterRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**replaceNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceNamespacedRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**replaceNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceNamespacedRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | + +### createClusterRole + + + +> V1ClusterRole createClusterRole(body) + +create a ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiCreateClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateClusterRoleRequest = { + + body: { + aggregationRule: { + clusterRoleSelectors: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + ], + }, + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRole**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ClusterRole + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createClusterRoleBinding + + + +> V1ClusterRoleBinding createClusterRoleBinding(body) + +create a ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiCreateClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateClusterRoleBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRoleBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedRole + + + +> V1Role createNamespacedRole(body) + +create a Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiCreateNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Role**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Role + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedRoleBinding + + + +> V1RoleBinding createNamespacedRoleBinding(body) + +create a RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RoleBinding**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1RoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteClusterRole + + + +> V1Status deleteClusterRole() + +delete a ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteClusterRoleBinding + + + +> V1Status deleteClusterRoleBinding() + +delete a ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterRole + + + +> V1Status deleteCollectionClusterRole() + +delete collection of ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterRoleBinding + + + +> V1Status deleteCollectionClusterRoleBinding() + +delete collection of ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedRole + + + +> V1Status deleteCollectionNamespacedRole() + +delete collection of Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedRoleBinding + + + +> V1Status deleteCollectionNamespacedRoleBinding() + +delete collection of RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedRole + + + +> V1Status deleteNamespacedRole() + +delete a Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedRoleBinding + + + +> V1Status deleteNamespacedRoleBinding() + +delete a RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterRole + + + +> V1ClusterRoleList listClusterRole() + +list or watch objects of kind ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListClusterRoleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterRoleBinding + + + +> V1ClusterRoleBindingList listClusterRoleBinding() + +list or watch objects of kind ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListClusterRoleBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedRole + + + +> V1RoleList listNamespacedRole() + +list or watch objects of kind Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RoleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedRoleBinding + + + +> V1RoleBindingList listNamespacedRoleBinding() + +list or watch objects of kind RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RoleBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listRoleBindingForAllNamespaces + + + +> V1RoleBindingList listRoleBindingForAllNamespaces() + +list or watch objects of kind RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRoleBindingForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RoleBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listRoleForAllNamespaces + + + +> V1RoleList listRoleForAllNamespaces() + +list or watch objects of kind Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListRoleForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListRoleForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRoleForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RoleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterRole + + + +> V1ClusterRole patchClusterRole(body) + +partially update the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiPatchClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ClusterRole + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchClusterRoleBinding + + + +> V1ClusterRoleBinding patchClusterRoleBinding(body) + +partially update the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiPatchClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedRole + + + +> V1Role patchNamespacedRole(body) + +partially update the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiPatchNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Role + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedRoleBinding + + + +> V1RoleBinding patchNamespacedRoleBinding(body) + +partially update the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1RoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readClusterRole + + + +> V1ClusterRole readClusterRole() + +read the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReadClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ClusterRole + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readClusterRoleBinding + + + +> V1ClusterRoleBinding readClusterRoleBinding() + +read the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReadClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedRole + + + +> V1Role readNamespacedRole() + +read the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReadNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Role + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedRoleBinding + + + +> V1RoleBinding readNamespacedRoleBinding() + +read the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1RoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterRole + + + +> V1ClusterRole replaceClusterRole(body) + +replace the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReplaceClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + + body: { + aggregationRule: { + clusterRoleSelectors: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + ], + }, + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRole**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ClusterRole + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceClusterRoleBinding + + + +> V1ClusterRoleBinding replaceClusterRoleBinding(body) + +replace the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRoleBinding**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedRole + + + +> V1Role replaceNamespacedRole(body) + +replace the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReplaceNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Role**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Role + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedRoleBinding + + + +> V1RoleBinding replaceNamespacedRoleBinding(body) + +replace the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RoleBinding**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1RoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/security/_category_.json b/website/docs/api-reference/security/_category_.json new file mode 100644 index 00000000000..45fba4709cc --- /dev/null +++ b/website/docs/api-reference/security/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Security", + "position": 4 +} diff --git a/website/docs/api-reference/workloads/AppsApi.md b/website/docs/api-reference/workloads/AppsApi.md new file mode 100644 index 00000000000..ca768916c31 --- /dev/null +++ b/website/docs/api-reference/workloads/AppsApi.md @@ -0,0 +1,62 @@ +--- +id: AppsApi +title: AppsApi +sidebar_label: AppsApi +sidebar_position: 1 +--- +# AppsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/workloads/AppsApi#getAPIGroup) | **GET** /apis/apps/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AppsApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/workloads/AppsV1Api.md b/website/docs/api-reference/workloads/AppsV1Api.md new file mode 100644 index 00000000000..61a75520691 --- /dev/null +++ b/website/docs/api-reference/workloads/AppsV1Api.md @@ -0,0 +1,28122 @@ +--- +id: AppsV1Api +title: AppsV1Api +sidebar_label: AppsV1Api +sidebar_position: 2 +--- +# AppsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#createNamespacedControllerRevision) | **POST** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**createNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedDaemonSet) | **POST** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**createNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#createNamespacedDeployment) | **POST** /apis/apps/v1/namespaces/{namespace}/deployments | +[**createNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedReplicaSet) | **POST** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**createNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedStatefulSet) | **POST** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**deleteCollectionNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**deleteCollectionNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**deleteCollectionNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments | +[**deleteCollectionNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**deleteCollectionNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**deleteNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**deleteNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**deleteNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**deleteNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**deleteNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**getAPIResources**](/docs/api-reference/workloads/AppsV1Api#getAPIResources) | **GET** /apis/apps/v1/ | +[**listControllerRevisionForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listControllerRevisionForAllNamespaces) | **GET** /apis/apps/v1/controllerrevisions | +[**listDaemonSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listDaemonSetForAllNamespaces) | **GET** /apis/apps/v1/daemonsets | +[**listDeploymentForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listDeploymentForAllNamespaces) | **GET** /apis/apps/v1/deployments | +[**listNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#listNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**listNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**listNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#listNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments | +[**listNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**listNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**listReplicaSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listReplicaSetForAllNamespaces) | **GET** /apis/apps/v1/replicasets | +[**listStatefulSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listStatefulSetForAllNamespaces) | **GET** /apis/apps/v1/statefulsets | +[**patchNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedControllerRevision) | **PATCH** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**patchNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDaemonSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**patchNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDaemonSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**patchNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeployment) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**patchNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeploymentScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**patchNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeploymentStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**patchNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**patchNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**patchNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**patchNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**patchNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**patchNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | +[**readNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#readNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**readNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**readNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDaemonSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**readNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**readNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeploymentScale) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**readNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeploymentStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**readNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**readNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**readNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**readNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**readNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**readNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | +[**replaceNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedControllerRevision) | **PUT** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**replaceNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDaemonSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**replaceNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDaemonSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**replaceNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeployment) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**replaceNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeploymentScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**replaceNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeploymentStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**replaceNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**replaceNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**replaceNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**replaceNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**replaceNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**replaceNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | + +### createNamespacedControllerRevision + + + +> V1ControllerRevision createNamespacedControllerRevision(body) + +create a ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: {}, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + revision: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ControllerRevision**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ControllerRevision + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedDaemonSet + + + +> V1DaemonSet createNamespacedDaemonSet(body) + +create a DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedDeployment + + + +> V1Deployment createNamespacedDeployment(body) + +create a Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedReplicaSet + + + +> V1ReplicaSet createNamespacedReplicaSet(body) + +create a ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedStatefulSet + + + +> V1StatefulSet createNamespacedStatefulSet(body) + +create a StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedControllerRevision + + + +> V1Status deleteCollectionNamespacedControllerRevision() + +delete collection of ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedDaemonSet + + + +> V1Status deleteCollectionNamespacedDaemonSet() + +delete collection of DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedDeployment + + + +> V1Status deleteCollectionNamespacedDeployment() + +delete collection of Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedReplicaSet + + + +> V1Status deleteCollectionNamespacedReplicaSet() + +delete collection of ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedStatefulSet + + + +> V1Status deleteCollectionNamespacedStatefulSet() + +delete collection of StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedControllerRevision + + + +> V1Status deleteNamespacedControllerRevision() + +delete a ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedDaemonSet + + + +> V1Status deleteNamespacedDaemonSet() + +delete a DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedDeployment + + + +> V1Status deleteNamespacedDeployment() + +delete a Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedReplicaSet + + + +> V1Status deleteNamespacedReplicaSet() + +delete a ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedStatefulSet + + + +> V1Status deleteNamespacedStatefulSet() + +delete a StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listControllerRevisionForAllNamespaces + + + +> V1ControllerRevisionList listControllerRevisionForAllNamespaces() + +list or watch objects of kind ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListControllerRevisionForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListControllerRevisionForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listControllerRevisionForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ControllerRevisionList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDaemonSetForAllNamespaces + + + +> V1DaemonSetList listDaemonSetForAllNamespaces() + +list or watch objects of kind DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListDaemonSetForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListDaemonSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDaemonSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DaemonSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeploymentForAllNamespaces + + + +> V1DeploymentList listDeploymentForAllNamespaces() + +list or watch objects of kind Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListDeploymentForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListDeploymentForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeploymentForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DeploymentList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedControllerRevision + + + +> V1ControllerRevisionList listNamespacedControllerRevision() + +list or watch objects of kind ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ControllerRevisionList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedDaemonSet + + + +> V1DaemonSetList listNamespacedDaemonSet() + +list or watch objects of kind DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DaemonSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedDeployment + + + +> V1DeploymentList listNamespacedDeployment() + +list or watch objects of kind Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DeploymentList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedReplicaSet + + + +> V1ReplicaSetList listNamespacedReplicaSet() + +list or watch objects of kind ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ReplicaSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedStatefulSet + + + +> V1StatefulSetList listNamespacedStatefulSet() + +list or watch objects of kind StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1StatefulSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listReplicaSetForAllNamespaces + + + +> V1ReplicaSetList listReplicaSetForAllNamespaces() + +list or watch objects of kind ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListReplicaSetForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListReplicaSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listReplicaSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ReplicaSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listStatefulSetForAllNamespaces + + + +> V1StatefulSetList listStatefulSetForAllNamespaces() + +list or watch objects of kind StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListStatefulSetForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListStatefulSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStatefulSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1StatefulSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedControllerRevision + + + +> V1ControllerRevision patchNamespacedControllerRevision(body) + +partially update the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ControllerRevision + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDaemonSet + + + +> V1DaemonSet patchNamespacedDaemonSet(body) + +partially update the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDaemonSetStatus + + + +> V1DaemonSet patchNamespacedDaemonSetStatus(body) + +partially update status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDeployment + + + +> V1Deployment patchNamespacedDeployment(body) + +partially update the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDeploymentScale + + + +> V1Scale patchNamespacedDeploymentScale(body) + +partially update scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDeploymentStatus + + + +> V1Deployment patchNamespacedDeploymentStatus(body) + +partially update status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicaSet + + + +> V1ReplicaSet patchNamespacedReplicaSet(body) + +partially update the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicaSetScale + + + +> V1Scale patchNamespacedReplicaSetScale(body) + +partially update scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicaSetStatus + + + +> V1ReplicaSet patchNamespacedReplicaSetStatus(body) + +partially update status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedStatefulSet + + + +> V1StatefulSet patchNamespacedStatefulSet(body) + +partially update the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedStatefulSetScale + + + +> V1Scale patchNamespacedStatefulSetScale(body) + +partially update scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedStatefulSetStatus + + + +> V1StatefulSet patchNamespacedStatefulSetStatus(body) + +partially update status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedControllerRevision + + + +> V1ControllerRevision readNamespacedControllerRevision() + +read the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ControllerRevision + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDaemonSet + + + +> V1DaemonSet readNamespacedDaemonSet() + +read the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDaemonSetStatus + + + +> V1DaemonSet readNamespacedDaemonSetStatus() + +read status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDeployment + + + +> V1Deployment readNamespacedDeployment() + +read the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDeploymentScale + + + +> V1Scale readNamespacedDeploymentScale() + +read scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDeploymentStatus + + + +> V1Deployment readNamespacedDeploymentStatus() + +read status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicaSet + + + +> V1ReplicaSet readNamespacedReplicaSet() + +read the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicaSetScale + + + +> V1Scale readNamespacedReplicaSetScale() + +read scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicaSetStatus + + + +> V1ReplicaSet readNamespacedReplicaSetStatus() + +read status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedStatefulSet + + + +> V1StatefulSet readNamespacedStatefulSet() + +read the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedStatefulSetScale + + + +> V1Scale readNamespacedStatefulSetScale() + +read scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedStatefulSetStatus + + + +> V1StatefulSet readNamespacedStatefulSetStatus() + +read status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedControllerRevision + + + +> V1ControllerRevision replaceNamespacedControllerRevision(body) + +replace the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: {}, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + revision: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ControllerRevision**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ControllerRevision + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDaemonSet + + + +> V1DaemonSet replaceNamespacedDaemonSet(body) + +replace the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDaemonSetStatus + + + +> V1DaemonSet replaceNamespacedDaemonSetStatus(body) + +replace status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDeployment + + + +> V1Deployment replaceNamespacedDeployment(body) + +replace the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDeploymentScale + + + +> V1Scale replaceNamespacedDeploymentScale(body) + +replace scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDeploymentStatus + + + +> V1Deployment replaceNamespacedDeploymentStatus(body) + +replace status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicaSet + + + +> V1ReplicaSet replaceNamespacedReplicaSet(body) + +replace the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicaSetScale + + + +> V1Scale replaceNamespacedReplicaSetScale(body) + +replace scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicaSetStatus + + + +> V1ReplicaSet replaceNamespacedReplicaSetStatus(body) + +replace status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedStatefulSet + + + +> V1StatefulSet replaceNamespacedStatefulSet(body) + +replace the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedStatefulSetScale + + + +> V1Scale replaceNamespacedStatefulSetScale(body) + +replace scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedStatefulSetStatus + + + +> V1StatefulSet replaceNamespacedStatefulSetStatus(body) + +replace status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/workloads/BatchApi.md b/website/docs/api-reference/workloads/BatchApi.md new file mode 100644 index 00000000000..6eecc6c2da6 --- /dev/null +++ b/website/docs/api-reference/workloads/BatchApi.md @@ -0,0 +1,62 @@ +--- +id: BatchApi +title: BatchApi +sidebar_label: BatchApi +sidebar_position: 3 +--- +# BatchApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/workloads/BatchApi#getAPIGroup) | **GET** /apis/batch/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, BatchApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/workloads/BatchV1Api.md b/website/docs/api-reference/workloads/BatchV1Api.md new file mode 100644 index 00000000000..3a672c79b93 --- /dev/null +++ b/website/docs/api-reference/workloads/BatchV1Api.md @@ -0,0 +1,13489 @@ +--- +id: BatchV1Api +title: BatchV1Api +sidebar_label: BatchV1Api +sidebar_position: 4 +--- +# BatchV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#createNamespacedCronJob) | **POST** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**createNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#createNamespacedJob) | **POST** /apis/batch/v1/namespaces/{namespace}/jobs | +[**deleteCollectionNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#deleteCollectionNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**deleteCollectionNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#deleteCollectionNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs | +[**deleteNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#deleteNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**deleteNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#deleteNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**getAPIResources**](/docs/api-reference/workloads/BatchV1Api#getAPIResources) | **GET** /apis/batch/v1/ | +[**listCronJobForAllNamespaces**](/docs/api-reference/workloads/BatchV1Api#listCronJobForAllNamespaces) | **GET** /apis/batch/v1/cronjobs | +[**listJobForAllNamespaces**](/docs/api-reference/workloads/BatchV1Api#listJobForAllNamespaces) | **GET** /apis/batch/v1/jobs | +[**listNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#listNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**listNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#listNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs | +[**patchNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedCronJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**patchNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedCronJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**patchNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**patchNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | +[**readNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#readNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**readNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#readNamespacedCronJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**readNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#readNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**readNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#readNamespacedJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | +[**replaceNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedCronJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**replaceNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedCronJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**replaceNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**replaceNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | + +### createNamespacedCronJob + + + +> V1CronJob createNamespacedCronJob(body) + +create a CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiCreateNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiCreateNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedJob + + + +> V1Job createNamespacedJob(body) + +create a Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiCreateNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiCreateNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedCronJob + + + +> V1Status deleteCollectionNamespacedCronJob() + +delete collection of CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiDeleteCollectionNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteCollectionNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedJob + + + +> V1Status deleteCollectionNamespacedJob() + +delete collection of Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiDeleteCollectionNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteCollectionNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedCronJob + + + +> V1Status deleteNamespacedCronJob() + +delete a CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiDeleteNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedJob + + + +> V1Status deleteNamespacedJob() + +delete a Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiDeleteNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCronJobForAllNamespaces + + + +> V1CronJobList listCronJobForAllNamespaces() + +list or watch objects of kind CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiListCronJobForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListCronJobForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCronJobForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CronJobList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listJobForAllNamespaces + + + +> V1JobList listJobForAllNamespaces() + +list or watch objects of kind Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiListJobForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListJobForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listJobForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1JobList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedCronJob + + + +> V1CronJobList listNamespacedCronJob() + +list or watch objects of kind CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiListNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CronJobList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedJob + + + +> V1JobList listNamespacedJob() + +list or watch objects of kind Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiListNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1JobList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedCronJob + + + +> V1CronJob patchNamespacedCronJob(body) + +partially update the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiPatchNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedCronJobStatus + + + +> V1CronJob patchNamespacedCronJobStatus(body) + +partially update status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiPatchNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedJob + + + +> V1Job patchNamespacedJob(body) + +partially update the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiPatchNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedJobStatus + + + +> V1Job patchNamespacedJobStatus(body) + +partially update status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiPatchNamespacedJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedCronJob + + + +> V1CronJob readNamespacedCronJob() + +read the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReadNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedCronJobStatus + + + +> V1CronJob readNamespacedCronJobStatus() + +read status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReadNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedJob + + + +> V1Job readNamespacedJob() + +read the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReadNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedJobStatus + + + +> V1Job readNamespacedJobStatus() + +read status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReadNamespacedJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedCronJob + + + +> V1CronJob replaceNamespacedCronJob(body) + +replace the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReplaceNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedCronJobStatus + + + +> V1CronJob replaceNamespacedCronJobStatus(body) + +replace status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReplaceNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedJob + + + +> V1Job replaceNamespacedJob(body) + +replace the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReplaceNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedJobStatus + + + +> V1Job replaceNamespacedJobStatus(body) + +replace status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReplaceNamespacedJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/docs/api-reference/workloads/_category_.json b/website/docs/api-reference/workloads/_category_.json new file mode 100644 index 00000000000..6f2c7368745 --- /dev/null +++ b/website/docs/api-reference/workloads/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Workloads", + "position": 2 +} diff --git a/website/docs/sdk/attach/classes/Attach.md b/website/docs/sdk/attach/classes/Attach.md new file mode 100644 index 00000000000..47ff766ad93 --- /dev/null +++ b/website/docs/sdk/attach/classes/Attach.md @@ -0,0 +1,75 @@ +# Class: Attach + +Defined in: [src/attach.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/attach.ts#L9) + +## Constructors + +### Constructor + +> **new Attach**(`config`, `websocketInterface?`): `Attach` + +Defined in: [src/attach.ts:14](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/attach.ts#L14) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +##### websocketInterface? + +`WebSocketInterface` + +#### Returns + +`Attach` + +## Properties + +### handler + +> **handler**: `WebSocketInterface` + +Defined in: [src/attach.ts:10](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/attach.ts#L10) + +## Methods + +### attach() + +> **attach**(`namespace`, `podName`, `containerName`, `stdout`, `stderr`, `stdin`, `tty`): `Promise`\<`WebSocket`\> + +Defined in: [src/attach.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/attach.ts#L18) + +#### Parameters + +##### namespace + +`string` + +##### podName + +`string` + +##### containerName + +`string` + +##### stdout + +`any` + +##### stderr + +`any` + +##### stdin + +`any` + +##### tty + +`boolean` + +#### Returns + +`Promise`\<`WebSocket`\> diff --git a/website/docs/sdk/attach/index.md b/website/docs/sdk/attach/index.md new file mode 100644 index 00000000000..5c8b2eedd03 --- /dev/null +++ b/website/docs/sdk/attach/index.md @@ -0,0 +1,5 @@ +# attach + +## Classes + +- [Attach](classes/Attach.md) diff --git a/website/docs/sdk/cache/classes/ListWatch.md b/website/docs/sdk/cache/classes/ListWatch.md new file mode 100644 index 00000000000..63da18f3757 --- /dev/null +++ b/website/docs/sdk/cache/classes/ListWatch.md @@ -0,0 +1,248 @@ +# Class: ListWatch\ + +Defined in: [src/cache.ts:26](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L26) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Implements + +- [`ObjectCache`](../interfaces/ObjectCache.md)\<`T`\> +- [`Informer`](../../informer/interfaces/Informer.md)\<`T`\> + +## Constructors + +### Constructor + +> **new ListWatch**\<`T`\>(`path`, `watch`, `listFn`, `autoStart?`, `labelSelector?`, `fieldSelector?`): `ListWatch`\<`T`\> + +Defined in: [src/cache.ts:39](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L39) + +#### Parameters + +##### path + +`string` + +##### watch + +[`Watch`](../../watch/classes/Watch.md) + +##### listFn + +[`ListPromise`](../../informer/type-aliases/ListPromise.md)\<`T`\> + +##### autoStart? + +`boolean` = `true` + +##### labelSelector? + +`string` + +##### fieldSelector? + +`string` + +#### Returns + +`ListWatch`\<`T`\> + +## Methods + +### get() + +> **get**(`name`, `namespace?`): `T` \| `undefined` + +Defined in: [src/cache.ts:113](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L113) + +#### Parameters + +##### name + +`string` + +##### namespace? + +`string` + +#### Returns + +`T` \| `undefined` + +#### Implementation of + +[`ObjectCache`](../interfaces/ObjectCache.md).[`get`](../interfaces/ObjectCache.md#get) + +*** + +### latestResourceVersion() + +> **latestResourceVersion**(): `string` + +Defined in: [src/cache.ts:136](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L136) + +#### Returns + +`string` + +*** + +### list() + +> **list**(`namespace?`): readonly `T`[] + +Defined in: [src/cache.ts:121](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L121) + +#### Parameters + +##### namespace? + +`string` + +#### Returns + +readonly `T`[] + +#### Implementation of + +[`ObjectCache`](../interfaces/ObjectCache.md).[`list`](../interfaces/ObjectCache.md#list) + +*** + +### off() + +#### Call Signature + +> **off**(`verb`, `cb`): `void` + +Defined in: [src/cache.ts:92](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L92) + +##### Parameters + +###### verb + +`"add"` \| `"update"` \| `"change"` \| `"delete"` + +###### cb + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\> + +##### Returns + +`void` + +##### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`off`](../../informer/interfaces/Informer.md#off) + +#### Call Signature + +> **off**(`verb`, `cb`): `void` + +Defined in: [src/cache.ts:93](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L93) + +##### Parameters + +###### verb + +`"connect"` \| `"error"` + +###### cb + +[`ErrorCallback`](../../informer/type-aliases/ErrorCallback.md) + +##### Returns + +`void` + +##### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`off`](../../informer/interfaces/Informer.md#off) + +*** + +### on() + +#### Call Signature + +> **on**(`verb`, `cb`): `void` + +Defined in: [src/cache.ts:74](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L74) + +##### Parameters + +###### verb + +`"add"` \| `"update"` \| `"change"` \| `"delete"` + +###### cb + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\> + +##### Returns + +`void` + +##### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`on`](../../informer/interfaces/Informer.md#on) + +#### Call Signature + +> **on**(`verb`, `cb`): `void` + +Defined in: [src/cache.ts:75](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L75) + +##### Parameters + +###### verb + +`"connect"` \| `"error"` + +###### cb + +[`ErrorCallback`](../../informer/type-aliases/ErrorCallback.md) + +##### Returns + +`void` + +##### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`on`](../../informer/interfaces/Informer.md#on) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [src/cache.ts:64](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L64) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`start`](../../informer/interfaces/Informer.md#start) + +*** + +### stop() + +> **stop**(): `Promise`\<`void`\> + +Defined in: [src/cache.ts:69](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L69) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`stop`](../../informer/interfaces/Informer.md#stop) diff --git a/website/docs/sdk/cache/functions/addOrUpdateObject.md b/website/docs/sdk/cache/functions/addOrUpdateObject.md new file mode 100644 index 00000000000..51abb80b33d --- /dev/null +++ b/website/docs/sdk/cache/functions/addOrUpdateObject.md @@ -0,0 +1,33 @@ +# Function: addOrUpdateObject() + +> **addOrUpdateObject**\<`T`\>(`objects`, `obj`, `addCallbacks?`, `updateCallbacks?`): `void` + +Defined in: [src/cache.ts:296](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L296) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### objects + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +### obj + +`T` + +### addCallbacks? + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] + +### updateCallbacks? + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] + +## Returns + +`void` diff --git a/website/docs/sdk/cache/functions/cacheMapFromList.md b/website/docs/sdk/cache/functions/cacheMapFromList.md new file mode 100644 index 00000000000..eafe57a5fc2 --- /dev/null +++ b/website/docs/sdk/cache/functions/cacheMapFromList.md @@ -0,0 +1,21 @@ +# Function: cacheMapFromList() + +> **cacheMapFromList**\<`T`\>(`newObjects`): [`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +Defined in: [src/cache.ts:244](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L244) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### newObjects + +`T`[] + +## Returns + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> diff --git a/website/docs/sdk/cache/functions/deleteItems.md b/website/docs/sdk/cache/functions/deleteItems.md new file mode 100644 index 00000000000..7b9ea627c57 --- /dev/null +++ b/website/docs/sdk/cache/functions/deleteItems.md @@ -0,0 +1,29 @@ +# Function: deleteItems() + +> **deleteItems**\<`T`\>(`oldObjects`, `newObjects`, `deleteCallback?`): [`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +Defined in: [src/cache.ts:264](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L264) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### oldObjects + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +### newObjects + +`T`[] + +### deleteCallback? + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] + +## Returns + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> diff --git a/website/docs/sdk/cache/functions/deleteObject.md b/website/docs/sdk/cache/functions/deleteObject.md new file mode 100644 index 00000000000..16e5302f4f7 --- /dev/null +++ b/website/docs/sdk/cache/functions/deleteObject.md @@ -0,0 +1,29 @@ +# Function: deleteObject() + +> **deleteObject**\<`T`\>(`objects`, `obj`, `deleteCallbacks?`): `void` + +Defined in: [src/cache.ts:334](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L334) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### objects + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +### obj + +`T` + +### deleteCallbacks? + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] + +## Returns + +`void` diff --git a/website/docs/sdk/cache/index.md b/website/docs/sdk/cache/index.md new file mode 100644 index 00000000000..0ad962b28b3 --- /dev/null +++ b/website/docs/sdk/cache/index.md @@ -0,0 +1,20 @@ +# cache + +## Classes + +- [ListWatch](classes/ListWatch.md) + +## Interfaces + +- [ObjectCache](interfaces/ObjectCache.md) + +## Type Aliases + +- [CacheMap](type-aliases/CacheMap.md) + +## Functions + +- [addOrUpdateObject](functions/addOrUpdateObject.md) +- [cacheMapFromList](functions/cacheMapFromList.md) +- [deleteItems](functions/deleteItems.md) +- [deleteObject](functions/deleteObject.md) diff --git a/website/docs/sdk/cache/interfaces/ObjectCache.md b/website/docs/sdk/cache/interfaces/ObjectCache.md new file mode 100644 index 00000000000..7254f9c75a4 --- /dev/null +++ b/website/docs/sdk/cache/interfaces/ObjectCache.md @@ -0,0 +1,49 @@ +# Interface: ObjectCache\ + +Defined in: [src/cache.ts:17](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L17) + +## Type Parameters + +### T + +`T` + +## Methods + +### get() + +> **get**(`name`, `namespace?`): `T` \| `undefined` + +Defined in: [src/cache.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L18) + +#### Parameters + +##### name + +`string` + +##### namespace? + +`string` + +#### Returns + +`T` \| `undefined` + +*** + +### list() + +> **list**(`namespace?`): readonly `T`[] + +Defined in: [src/cache.ts:20](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L20) + +#### Parameters + +##### namespace? + +`string` + +#### Returns + +readonly `T`[] diff --git a/website/docs/sdk/cache/type-aliases/CacheMap.md b/website/docs/sdk/cache/type-aliases/CacheMap.md new file mode 100644 index 00000000000..15cd2002ae6 --- /dev/null +++ b/website/docs/sdk/cache/type-aliases/CacheMap.md @@ -0,0 +1,11 @@ +# Type Alias: CacheMap\ + +> **CacheMap**\<`T`\> = `Map`\<`string`, `Map`\<`string`, `T`\>\> + +Defined in: [src/cache.ts:24](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L24) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) diff --git a/website/docs/sdk/config/classes/KubeConfig.md b/website/docs/sdk/config/classes/KubeConfig.md new file mode 100644 index 00000000000..9ad78d210da --- /dev/null +++ b/website/docs/sdk/config/classes/KubeConfig.md @@ -0,0 +1,559 @@ +# Class: KubeConfig + +Defined in: [src/config.ts:68](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L68) + +## Implements + +- `SecurityAuthentication` + +## Constructors + +### Constructor + +> **new KubeConfig**(): `KubeConfig` + +Defined in: [src/config.ts:106](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L106) + +#### Returns + +`KubeConfig` + +## Properties + +### clusters + +> **clusters**: [`Cluster`](../../config_types/interfaces/Cluster.md)[] + +Defined in: [src/config.ts:89](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L89) + +The list of all known clusters + +*** + +### contexts + +> **contexts**: [`Context`](../../config_types/interfaces/Context.md)[] + +Defined in: [src/config.ts:99](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L99) + +The list of all known contexts + +*** + +### currentContext + +> **currentContext**: `string` + +Defined in: [src/config.ts:104](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L104) + +The name of the current context + +*** + +### users + +> **users**: [`User`](../../config_types/interfaces/User.md)[] + +Defined in: [src/config.ts:94](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L94) + +The list of all known users + +## Methods + +### addAuthenticator() + +> **addAuthenticator**(`authenticator`): `void` + +Defined in: [src/config.ts:82](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L82) + +#### Parameters + +##### authenticator + +`Authenticator` + +#### Returns + +`void` + +*** + +### addCluster() + +> **addCluster**(`cluster`): `void` + +Defined in: [src/config.ts:385](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L385) + +#### Parameters + +##### cluster + +[`Cluster`](../../config_types/interfaces/Cluster.md) + +#### Returns + +`void` + +*** + +### addContext() + +> **addContext**(`ctx`): `void` + +Defined in: [src/config.ts:409](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L409) + +#### Parameters + +##### ctx + +[`Context`](../../config_types/interfaces/Context.md) + +#### Returns + +`void` + +*** + +### addUser() + +> **addUser**(`user`): `void` + +Defined in: [src/config.ts:397](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L397) + +#### Parameters + +##### user + +[`User`](../../config_types/interfaces/User.md) + +#### Returns + +`void` + +*** + +### applySecurityAuthentication() + +> **applySecurityAuthentication**(`context`): `Promise`\<`void`\> + +Defined in: [src/config.ts:239](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L239) + +Applies SecurityAuthentication to RequestContext of an API Call from API Client + +#### Parameters + +##### context + +`RequestContext` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +`SecurityAuthentication.applySecurityAuthentication` + +*** + +### applyToFetchOptions() + +> **applyToFetchOptions**(`opts`): `Promise`\<`RequestInit`\> + +Defined in: [src/config.ts:169](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L169) + +#### Parameters + +##### opts + +`RequestOptions` + +#### Returns + +`Promise`\<`RequestInit`\> + +*** + +### applyToHTTPSOptions() + +> **applyToHTTPSOptions**(`opts`): `Promise`\<`void`\> + +Defined in: [src/config.ts:192](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L192) + +#### Parameters + +##### opts + +`any` + +#### Returns + +`Promise`\<`void`\> + +*** + +### exportConfig() + +> **exportConfig**(): `string` + +Defined in: [src/config.ts:526](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L526) + +#### Returns + +`string` + +*** + +### getCluster() + +> **getCluster**(`name`): [`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` + +Defined in: [src/config.ts:147](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L147) + +#### Parameters + +##### name + +`string` + +#### Returns + +[`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` + +*** + +### getClusters() + +> **getClusters**(): [`Cluster`](../../config_types/interfaces/Cluster.md)[] + +Defined in: [src/config.ts:116](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L116) + +#### Returns + +[`Cluster`](../../config_types/interfaces/Cluster.md)[] + +*** + +### getContextObject() + +> **getContextObject**(`name`): [`Context`](../../config_types/interfaces/Context.md) \| `null` + +Defined in: [src/config.ts:132](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L132) + +#### Parameters + +##### name + +`string` + +#### Returns + +[`Context`](../../config_types/interfaces/Context.md) \| `null` + +*** + +### getContexts() + +> **getContexts**(): [`Context`](../../config_types/interfaces/Context.md)[] + +Defined in: [src/config.ts:112](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L112) + +#### Returns + +[`Context`](../../config_types/interfaces/Context.md)[] + +*** + +### getCurrentCluster() + +> **getCurrentCluster**(): [`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` + +Defined in: [src/config.ts:139](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L139) + +#### Returns + +[`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` + +*** + +### getCurrentContext() + +> **getCurrentContext**(): `string` + +Defined in: [src/config.ts:124](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L124) + +#### Returns + +`string` + +*** + +### getCurrentUser() + +> **getCurrentUser**(): [`User`](../../config_types/interfaces/User.md) \| `null` + +Defined in: [src/config.ts:151](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L151) + +#### Returns + +[`User`](../../config_types/interfaces/User.md) \| `null` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: [src/config.ts:285](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L285) + +Returns name of this security authentication method + +#### Returns + +`string` + +string + +#### Implementation of + +`SecurityAuthentication.getName` + +*** + +### getUser() + +> **getUser**(`name`): [`User`](../../config_types/interfaces/User.md) \| `null` + +Defined in: [src/config.ts:159](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L159) + +#### Parameters + +##### name + +`string` + +#### Returns + +[`User`](../../config_types/interfaces/User.md) \| `null` + +*** + +### getUsers() + +> **getUsers**(): [`User`](../../config_types/interfaces/User.md)[] + +Defined in: [src/config.ts:120](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L120) + +#### Returns + +[`User`](../../config_types/interfaces/User.md)[] + +*** + +### loadFromCluster() + +> **loadFromCluster**(`pathPrefix?`): `void` + +Defined in: [src/config.ts:317](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L317) + +#### Parameters + +##### pathPrefix? + +`string` = `''` + +#### Returns + +`void` + +*** + +### loadFromClusterAndUser() + +> **loadFromClusterAndUser**(`cluster`, `user`): `void` + +Defined in: [src/config.ts:304](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L304) + +#### Parameters + +##### cluster + +[`Cluster`](../../config_types/interfaces/Cluster.md) + +##### user + +[`User`](../../config_types/interfaces/User.md) + +#### Returns + +`void` + +*** + +### loadFromDefault() + +> **loadFromDefault**(`opts?`, `contextFromStartingConfig?`, `platform?`): `void` + +Defined in: [src/config.ts:421](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L421) + +#### Parameters + +##### opts? + +`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> + +##### contextFromStartingConfig? + +`boolean` = `false` + +##### platform? + +`string` = `process.platform` + +#### Returns + +`void` + +*** + +### loadFromFile() + +> **loadFromFile**(`file`, `opts?`): `void` + +Defined in: [src/config.ts:163](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L163) + +#### Parameters + +##### file + +`string` + +##### opts? + +`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> + +#### Returns + +`void` + +*** + +### loadFromOptions() + +> **loadFromOptions**(`options`): `void` + +Defined in: [src/config.ts:297](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L297) + +#### Parameters + +##### options + +`any` + +#### Returns + +`void` + +*** + +### loadFromString() + +> **loadFromString**(`config`, `opts?`): `void` + +Defined in: [src/config.ts:289](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L289) + +#### Parameters + +##### config + +`string` + +##### opts? + +`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> + +#### Returns + +`void` + +*** + +### makeApiClient() + +> **makeApiClient**\<`T`\>(`apiClientType`): `T` + +Defined in: [src/config.ts:490](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L490) + +#### Type Parameters + +##### T + +`T` *extends* [`ApiType`](../interfaces/ApiType.md) + +#### Parameters + +##### apiClientType + +[`ApiConstructor`](../type-aliases/ApiConstructor.md)\<`T`\> + +#### Returns + +`T` + +*** + +### makePathsAbsolute() + +> **makePathsAbsolute**(`rootDirectory`): `void` + +Defined in: [src/config.ts:510](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L510) + +#### Parameters + +##### rootDirectory + +`string` + +#### Returns + +`void` + +*** + +### mergeConfig() + +> **mergeConfig**(`config`, `preserveContext?`): `void` + +Defined in: [src/config.ts:370](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L370) + +#### Parameters + +##### config + +`KubeConfig` + +##### preserveContext? + +`boolean` = `false` + +#### Returns + +`void` + +*** + +### setCurrentContext() + +> **setCurrentContext**(`context`): `void` + +Defined in: [src/config.ts:128](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L128) + +#### Parameters + +##### context + +`string` + +#### Returns + +`void` diff --git a/website/docs/sdk/config/functions/bufferFromFileOrString.md b/website/docs/sdk/config/functions/bufferFromFileOrString.md new file mode 100644 index 00000000000..abf155bebf4 --- /dev/null +++ b/website/docs/sdk/config/functions/bufferFromFileOrString.md @@ -0,0 +1,19 @@ +# Function: bufferFromFileOrString() + +> **bufferFromFileOrString**(`file?`, `data?`): `Buffer` \| `null` + +Defined in: [src/config.ts:652](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L652) + +## Parameters + +### file? + +`string` + +### data? + +`string` + +## Returns + +`Buffer` \| `null` diff --git a/website/docs/sdk/config/functions/findHomeDir.md b/website/docs/sdk/config/functions/findHomeDir.md new file mode 100644 index 00000000000..dcd6aeaee2a --- /dev/null +++ b/website/docs/sdk/config/functions/findHomeDir.md @@ -0,0 +1,15 @@ +# Function: findHomeDir() + +> **findHomeDir**(`platform?`): `string` \| `null` + +Defined in: [src/config.ts:675](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L675) + +## Parameters + +### platform? + +`string` = `process.platform` + +## Returns + +`string` \| `null` diff --git a/website/docs/sdk/config/functions/findObject.md b/website/docs/sdk/config/functions/findObject.md new file mode 100644 index 00000000000..9cad51430a0 --- /dev/null +++ b/website/docs/sdk/config/functions/findObject.md @@ -0,0 +1,29 @@ +# Function: findObject() + +> **findObject**\<`T`\>(`list`, `name`, `key`): `T` \| `null` + +Defined in: [src/config.ts:734](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L734) + +## Type Parameters + +### T + +`T` *extends* [`Named`](../interfaces/Named.md) + +## Parameters + +### list + +`T`[] + +### name + +`string` + +### key + +`string` + +## Returns + +`T` \| `null` diff --git a/website/docs/sdk/config/functions/makeAbsolutePath.md b/website/docs/sdk/config/functions/makeAbsolutePath.md new file mode 100644 index 00000000000..ca184049b6b --- /dev/null +++ b/website/docs/sdk/config/functions/makeAbsolutePath.md @@ -0,0 +1,19 @@ +# Function: makeAbsolutePath() + +> **makeAbsolutePath**(`root`, `file`): `string` + +Defined in: [src/config.ts:644](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L644) + +## Parameters + +### root + +`string` + +### file + +`string` + +## Returns + +`string` diff --git a/website/docs/sdk/config/index.md b/website/docs/sdk/config/index.md new file mode 100644 index 00000000000..9b7c0e788d9 --- /dev/null +++ b/website/docs/sdk/config/index.md @@ -0,0 +1,21 @@ +# config + +## Classes + +- [KubeConfig](classes/KubeConfig.md) + +## Interfaces + +- [ApiType](interfaces/ApiType.md) +- [Named](interfaces/Named.md) + +## Type Aliases + +- [ApiConstructor](type-aliases/ApiConstructor.md) + +## Functions + +- [bufferFromFileOrString](functions/bufferFromFileOrString.md) +- [findHomeDir](functions/findHomeDir.md) +- [findObject](functions/findObject.md) +- [makeAbsolutePath](functions/makeAbsolutePath.md) diff --git a/website/docs/sdk/config/interfaces/ApiType.md b/website/docs/sdk/config/interfaces/ApiType.md new file mode 100644 index 00000000000..5406d3b4c89 --- /dev/null +++ b/website/docs/sdk/config/interfaces/ApiType.md @@ -0,0 +1,3 @@ +# Interface: ApiType + +Defined in: [src/config.ts:66](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L66) diff --git a/website/docs/sdk/config/interfaces/Named.md b/website/docs/sdk/config/interfaces/Named.md new file mode 100644 index 00000000000..f1480568686 --- /dev/null +++ b/website/docs/sdk/config/interfaces/Named.md @@ -0,0 +1,11 @@ +# Interface: Named + +Defined in: [src/config.ts:729](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L729) + +## Properties + +### name + +> **name**: `string` + +Defined in: [src/config.ts:730](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L730) diff --git a/website/docs/sdk/config/type-aliases/ApiConstructor.md b/website/docs/sdk/config/type-aliases/ApiConstructor.md new file mode 100644 index 00000000000..22b5638b276 --- /dev/null +++ b/website/docs/sdk/config/type-aliases/ApiConstructor.md @@ -0,0 +1,21 @@ +# Type Alias: ApiConstructor\ + +> **ApiConstructor**\<`T`\> = (`config`) => `T` + +Defined in: [src/config.ts:642](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L642) + +## Type Parameters + +### T + +`T` *extends* [`ApiType`](../interfaces/ApiType.md) + +## Parameters + +### config + +`Configuration` + +## Returns + +`T` diff --git a/website/docs/sdk/config_types/functions/exportCluster.md b/website/docs/sdk/config_types/functions/exportCluster.md new file mode 100644 index 00000000000..2ef992801b6 --- /dev/null +++ b/website/docs/sdk/config_types/functions/exportCluster.md @@ -0,0 +1,15 @@ +# Function: exportCluster() + +> **exportCluster**(`cluster`): `any` + +Defined in: [src/config\_types.ts:40](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L40) + +## Parameters + +### cluster + +[`Cluster`](../interfaces/Cluster.md) + +## Returns + +`any` diff --git a/website/docs/sdk/config_types/functions/exportContext.md b/website/docs/sdk/config_types/functions/exportContext.md new file mode 100644 index 00000000000..db3175d764c --- /dev/null +++ b/website/docs/sdk/config_types/functions/exportContext.md @@ -0,0 +1,15 @@ +# Function: exportContext() + +> **exportContext**(`ctx`): `any` + +Defined in: [src/config\_types.ts:190](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L190) + +## Parameters + +### ctx + +[`Context`](../interfaces/Context.md) + +## Returns + +`any` diff --git a/website/docs/sdk/config_types/functions/exportUser.md b/website/docs/sdk/config_types/functions/exportUser.md new file mode 100644 index 00000000000..90ad74dbdf1 --- /dev/null +++ b/website/docs/sdk/config_types/functions/exportUser.md @@ -0,0 +1,15 @@ +# Function: exportUser() + +> **exportUser**(`user`): `any` + +Defined in: [src/config\_types.ts:113](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L113) + +## Parameters + +### user + +[`User`](../interfaces/User.md) + +## Returns + +`any` diff --git a/website/docs/sdk/config_types/functions/newClusters.md b/website/docs/sdk/config_types/functions/newClusters.md new file mode 100644 index 00000000000..a5c7b658ca8 --- /dev/null +++ b/website/docs/sdk/config_types/functions/newClusters.md @@ -0,0 +1,19 @@ +# Function: newClusters() + +> **newClusters**(`a`, `opts?`): [`Cluster`](../interfaces/Cluster.md)[] + +Defined in: [src/config\_types.ts:30](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L30) + +## Parameters + +### a + +`any` + +### opts? + +`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> + +## Returns + +[`Cluster`](../interfaces/Cluster.md)[] diff --git a/website/docs/sdk/config_types/functions/newContexts.md b/website/docs/sdk/config_types/functions/newContexts.md new file mode 100644 index 00000000000..c3afceea381 --- /dev/null +++ b/website/docs/sdk/config_types/functions/newContexts.md @@ -0,0 +1,19 @@ +# Function: newContexts() + +> **newContexts**(`a`, `opts?`): [`Context`](../interfaces/Context.md)[] + +Defined in: [src/config\_types.ts:180](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L180) + +## Parameters + +### a + +`any` + +### opts? + +`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> + +## Returns + +[`Context`](../interfaces/Context.md)[] diff --git a/website/docs/sdk/config_types/functions/newUsers.md b/website/docs/sdk/config_types/functions/newUsers.md new file mode 100644 index 00000000000..d6fba827803 --- /dev/null +++ b/website/docs/sdk/config_types/functions/newUsers.md @@ -0,0 +1,19 @@ +# Function: newUsers() + +> **newUsers**(`a`, `opts?`): [`User`](../interfaces/User.md)[] + +Defined in: [src/config\_types.ts:103](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L103) + +## Parameters + +### a + +`any` + +### opts? + +`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> + +## Returns + +[`User`](../interfaces/User.md)[] diff --git a/website/docs/sdk/config_types/index.md b/website/docs/sdk/config_types/index.md new file mode 100644 index 00000000000..35ebc25425d --- /dev/null +++ b/website/docs/sdk/config_types/index.md @@ -0,0 +1,25 @@ +# config\_types + +## Interfaces + +- [Cluster](interfaces/Cluster.md) +- [ConfigOptions](interfaces/ConfigOptions.md) +- [Context](interfaces/Context.md) +- [User](interfaces/User.md) + +## Type Aliases + +- [ActionOnInvalid](type-aliases/ActionOnInvalid.md) + +## Variables + +- [ActionOnInvalid](variables/ActionOnInvalid.md) + +## Functions + +- [exportCluster](functions/exportCluster.md) +- [exportContext](functions/exportContext.md) +- [exportUser](functions/exportUser.md) +- [newClusters](functions/newClusters.md) +- [newContexts](functions/newContexts.md) +- [newUsers](functions/newUsers.md) diff --git a/website/docs/sdk/config_types/interfaces/Cluster.md b/website/docs/sdk/config_types/interfaces/Cluster.md new file mode 100644 index 00000000000..5b2d7cb273d --- /dev/null +++ b/website/docs/sdk/config_types/interfaces/Cluster.md @@ -0,0 +1,59 @@ +# Interface: Cluster + +Defined in: [src/config\_types.ts:20](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L20) + +## Properties + +### caData? + +> `readonly` `optional` **caData?**: `string` + +Defined in: [src/config\_types.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L22) + +*** + +### caFile? + +> `optional` **caFile?**: `string` + +Defined in: [src/config\_types.ts:23](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L23) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: [src/config\_types.ts:21](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L21) + +*** + +### proxyUrl? + +> `readonly` `optional` **proxyUrl?**: `string` + +Defined in: [src/config\_types.ts:27](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L27) + +*** + +### server + +> `readonly` **server**: `string` + +Defined in: [src/config\_types.ts:24](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L24) + +*** + +### skipTLSVerify + +> `readonly` **skipTLSVerify**: `boolean` + +Defined in: [src/config\_types.ts:26](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L26) + +*** + +### tlsServerName? + +> `readonly` `optional` **tlsServerName?**: `string` + +Defined in: [src/config\_types.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L25) diff --git a/website/docs/sdk/config_types/interfaces/ConfigOptions.md b/website/docs/sdk/config_types/interfaces/ConfigOptions.md new file mode 100644 index 00000000000..990ee91e7bb --- /dev/null +++ b/website/docs/sdk/config_types/interfaces/ConfigOptions.md @@ -0,0 +1,11 @@ +# Interface: ConfigOptions + +Defined in: [src/config\_types.ts:10](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L10) + +## Properties + +### onInvalidEntry + +> **onInvalidEntry**: [`ActionOnInvalid`](../type-aliases/ActionOnInvalid.md) + +Defined in: [src/config\_types.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L11) diff --git a/website/docs/sdk/config_types/interfaces/Context.md b/website/docs/sdk/config_types/interfaces/Context.md new file mode 100644 index 00000000000..ee680eacb66 --- /dev/null +++ b/website/docs/sdk/config_types/interfaces/Context.md @@ -0,0 +1,35 @@ +# Interface: Context + +Defined in: [src/config\_types.ts:173](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L173) + +## Properties + +### cluster + +> `readonly` **cluster**: `string` + +Defined in: [src/config\_types.ts:174](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L174) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: [src/config\_types.ts:176](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L176) + +*** + +### namespace? + +> `readonly` `optional` **namespace?**: `string` + +Defined in: [src/config\_types.ts:177](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L177) + +*** + +### user + +> `readonly` **user**: `string` + +Defined in: [src/config\_types.ts:175](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L175) diff --git a/website/docs/sdk/config_types/interfaces/User.md b/website/docs/sdk/config_types/interfaces/User.md new file mode 100644 index 00000000000..e2378af16a4 --- /dev/null +++ b/website/docs/sdk/config_types/interfaces/User.md @@ -0,0 +1,91 @@ +# Interface: User + +Defined in: [src/config\_types.ts:89](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L89) + +## Properties + +### authProvider? + +> `readonly` `optional` **authProvider?**: `any` + +Defined in: [src/config\_types.ts:96](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L96) + +*** + +### certData? + +> `readonly` `optional` **certData?**: `string` + +Defined in: [src/config\_types.ts:91](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L91) + +*** + +### certFile? + +> `optional` **certFile?**: `string` + +Defined in: [src/config\_types.ts:92](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L92) + +*** + +### exec? + +> `readonly` `optional` **exec?**: `any` + +Defined in: [src/config\_types.ts:93](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L93) + +*** + +### impersonateUser? + +> `readonly` `optional` **impersonateUser?**: `string` + +Defined in: [src/config\_types.ts:100](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L100) + +*** + +### keyData? + +> `readonly` `optional` **keyData?**: `string` + +Defined in: [src/config\_types.ts:94](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L94) + +*** + +### keyFile? + +> `optional` **keyFile?**: `string` + +Defined in: [src/config\_types.ts:95](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L95) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: [src/config\_types.ts:90](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L90) + +*** + +### password? + +> `readonly` `optional` **password?**: `string` + +Defined in: [src/config\_types.ts:99](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L99) + +*** + +### token? + +> `readonly` `optional` **token?**: `string` + +Defined in: [src/config\_types.ts:97](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L97) + +*** + +### username? + +> `readonly` `optional` **username?**: `string` + +Defined in: [src/config\_types.ts:98](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L98) diff --git a/website/docs/sdk/config_types/type-aliases/ActionOnInvalid.md b/website/docs/sdk/config_types/type-aliases/ActionOnInvalid.md new file mode 100644 index 00000000000..5efbfe045a9 --- /dev/null +++ b/website/docs/sdk/config_types/type-aliases/ActionOnInvalid.md @@ -0,0 +1,5 @@ +# Type Alias: ActionOnInvalid + +> **ActionOnInvalid** = *typeof* [`ActionOnInvalid`](../variables/ActionOnInvalid.md)\[keyof *typeof* [`ActionOnInvalid`](../variables/ActionOnInvalid.md)\] + +Defined in: [src/config\_types.ts:3](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L3) diff --git a/website/docs/sdk/config_types/variables/ActionOnInvalid.md b/website/docs/sdk/config_types/variables/ActionOnInvalid.md new file mode 100644 index 00000000000..fc3653c8e3e --- /dev/null +++ b/website/docs/sdk/config_types/variables/ActionOnInvalid.md @@ -0,0 +1,15 @@ +# Variable: ActionOnInvalid + +> `const` **ActionOnInvalid**: `object` + +Defined in: [src/config\_types.ts:3](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L3) + +## Type Declaration + +### FILTER + +> `readonly` **FILTER**: `"filter"` = `'filter'` + +### THROW + +> `readonly` **THROW**: `"throw"` = `'throw'` diff --git a/website/docs/sdk/cp/classes/Cp.md b/website/docs/sdk/cp/classes/Cp.md new file mode 100644 index 00000000000..8caf135c89e --- /dev/null +++ b/website/docs/sdk/cp/classes/Cp.md @@ -0,0 +1,127 @@ +# Class: Cp + +Defined in: [src/cp.ts:7](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L7) + +## Constructors + +### Constructor + +> **new Cp**(`config`, `execInstance?`): `Cp` + +Defined in: [src/cp.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L9) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +##### execInstance? + +[`Exec`](../../exec/classes/Exec.md) + +#### Returns + +`Cp` + +## Properties + +### execInstance + +> **execInstance**: [`Exec`](../../exec/classes/Exec.md) + +Defined in: [src/cp.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L8) + +## Methods + +### cpFromPod() + +> **cpFromPod**(`namespace`, `podName`, `containerName`, `srcPath`, `tgtPath`, `cwd?`): `Promise`\<`void`\> + +Defined in: [src/cp.ts:21](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L21) + +#### Parameters + +##### namespace + +`string` + +The namespace of the pod to exec the command inside. + +##### podName + +`string` + +The name of the pod to exec the command inside. + +##### containerName + +`string` + +The name of the container in the pod to exec the command inside. + +##### srcPath + +`string` + +The source path in the pod + +##### tgtPath + +`string` + +The target path in local + +##### cwd? + +`string` + +The directory that is used as the parent in the pod when downloading + +#### Returns + +`Promise`\<`void`\> + +*** + +### cpToPod() + +> **cpToPod**(`namespace`, `podName`, `containerName`, `srcPath`, `tgtPath`): `Promise`\<`void`\> + +Defined in: [src/cp.ts:60](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L60) + +#### Parameters + +##### namespace + +`string` + +The namespace of the pod to exec the command inside. + +##### podName + +`string` + +The name of the pod to exec the command inside. + +##### containerName + +`string` + +The name of the container in the pod to exec the command inside. + +##### srcPath + +`string` + +The source path in local + +##### tgtPath + +`string` + +The target path in the pod + +#### Returns + +`Promise`\<`void`\> diff --git a/website/docs/sdk/cp/index.md b/website/docs/sdk/cp/index.md new file mode 100644 index 00000000000..67baee4077a --- /dev/null +++ b/website/docs/sdk/cp/index.md @@ -0,0 +1,5 @@ +# cp + +## Classes + +- [Cp](classes/Cp.md) diff --git a/website/docs/sdk/exec/classes/Exec.md b/website/docs/sdk/exec/classes/Exec.md new file mode 100644 index 00000000000..297c7d4b1fc --- /dev/null +++ b/website/docs/sdk/exec/classes/Exec.md @@ -0,0 +1,103 @@ +# Class: Exec + +Defined in: [src/exec.ts:10](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/exec.ts#L10) + +## Constructors + +### Constructor + +> **new Exec**(`config`, `wsInterface?`): `Exec` + +Defined in: [src/exec.ts:15](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/exec.ts#L15) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +##### wsInterface? + +`WebSocketInterface` + +#### Returns + +`Exec` + +## Properties + +### handler + +> **handler**: `WebSocketInterface` + +Defined in: [src/exec.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/exec.ts#L11) + +## Methods + +### exec() + +> **exec**(`namespace`, `podName`, `containerName`, `command`, `stdout`, `stderr`, `stdin`, `tty`, `statusCallback?`): `Promise`\<`WebSocket`\> + +Defined in: [src/exec.ts:32](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/exec.ts#L32) + +#### Parameters + +##### namespace + +`string` + +The namespace of the pod to exec the command inside. + +##### podName + +`string` + +The name of the pod to exec the command inside. + +##### containerName + +`string` + +The name of the container in the pod to exec the command inside. + +##### command + +`string` \| `string`[] + +The command or command and arguments to execute. + +##### stdout + +`Writable` \| `null` + +The stream to write stdout data from the command. + +##### stderr + +`Writable` \| `null` + +The stream to write stderr data from the command. + +##### stdin + +`Readable` \| `null` + +The stream to write stdin data into the command. + +##### tty + +`boolean` + +Should the command execute in a TTY enabled session. + +##### statusCallback? + +(`status`) => `void` + +A callback to received the status (e.g. exit code) from the command, optional. + +#### Returns + +`Promise`\<`WebSocket`\> + +A promise that will return the web socket created for this command. diff --git a/website/docs/sdk/exec/index.md b/website/docs/sdk/exec/index.md new file mode 100644 index 00000000000..84d31a7aad2 --- /dev/null +++ b/website/docs/sdk/exec/index.md @@ -0,0 +1,5 @@ +# exec + +## Classes + +- [Exec](classes/Exec.md) diff --git a/website/docs/sdk/health/classes/Health.md b/website/docs/sdk/health/classes/Health.md new file mode 100644 index 00000000000..4c6e8144d03 --- /dev/null +++ b/website/docs/sdk/health/classes/Health.md @@ -0,0 +1,65 @@ +# Class: Health + +Defined in: [src/health.ts:5](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L5) + +## Constructors + +### Constructor + +> **new Health**(`config`): `Health` + +Defined in: [src/health.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L8) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +#### Returns + +`Health` + +## Properties + +### config + +> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) + +Defined in: [src/health.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L6) + +## Methods + +### livez() + +> **livez**(`opts`): `Promise`\<`boolean`\> + +Defined in: [src/health.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L16) + +#### Parameters + +##### opts + +`RequestOptions` + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### readyz() + +> **readyz**(`opts`): `Promise`\<`boolean`\> + +Defined in: [src/health.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L12) + +#### Parameters + +##### opts + +`RequestOptions` + +#### Returns + +`Promise`\<`boolean`\> diff --git a/website/docs/sdk/health/index.md b/website/docs/sdk/health/index.md new file mode 100644 index 00000000000..ee17d9e0f20 --- /dev/null +++ b/website/docs/sdk/health/index.md @@ -0,0 +1,5 @@ +# health + +## Classes + +- [Health](classes/Health.md) diff --git a/website/docs/sdk/index.md b/website/docs/sdk/index.md new file mode 100644 index 00000000000..206b899986f --- /dev/null +++ b/website/docs/sdk/index.md @@ -0,0 +1,22 @@ +# @kubernetes/client-node + +## Modules + +- [attach](attach/index.md) +- [cache](cache/index.md) +- [config](config/index.md) +- [config\_types](config_types/index.md) +- [cp](cp/index.md) +- [exec](exec/index.md) +- [health](health/index.md) +- [informer](informer/index.md) +- [log](log/index.md) +- [metrics](metrics/index.md) +- [middleware](middleware/index.md) +- [object](object/index.md) +- [patch](patch/index.md) +- [portforward](portforward/index.md) +- [top](top/index.md) +- [types](types/index.md) +- [watch](watch/index.md) +- [yaml](yaml/index.md) diff --git a/website/docs/sdk/informer/functions/makeInformer.md b/website/docs/sdk/informer/functions/makeInformer.md new file mode 100644 index 00000000000..041b93c350b --- /dev/null +++ b/website/docs/sdk/informer/functions/makeInformer.md @@ -0,0 +1,33 @@ +# Function: makeInformer() + +> **makeInformer**\<`T`\>(`kubeconfig`, `path`, `listPromiseFn`, `labelSelector?`): [`Informer`](../interfaces/Informer.md)\<`T`\> & [`ObjectCache`](../../cache/interfaces/ObjectCache.md)\<`T`\> + +Defined in: [src/informer.ts:37](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L37) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### kubeconfig + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +### path + +`string` + +### listPromiseFn + +[`ListPromise`](../type-aliases/ListPromise.md)\<`T`\> + +### labelSelector? + +`string` + +## Returns + +[`Informer`](../interfaces/Informer.md)\<`T`\> & [`ObjectCache`](../../cache/interfaces/ObjectCache.md)\<`T`\> diff --git a/website/docs/sdk/informer/index.md b/website/docs/sdk/informer/index.md new file mode 100644 index 00000000000..b8b436f663a --- /dev/null +++ b/website/docs/sdk/informer/index.md @@ -0,0 +1,31 @@ +# informer + +## Interfaces + +- [Informer](interfaces/Informer.md) + +## Type Aliases + +- [ADD](type-aliases/ADD.md) +- [CHANGE](type-aliases/CHANGE.md) +- [CONNECT](type-aliases/CONNECT.md) +- [DELETE](type-aliases/DELETE.md) +- [ERROR](type-aliases/ERROR.md) +- [ErrorCallback](type-aliases/ErrorCallback.md) +- [ListCallback](type-aliases/ListCallback.md) +- [ListPromise](type-aliases/ListPromise.md) +- [ObjectCallback](type-aliases/ObjectCallback.md) +- [UPDATE](type-aliases/UPDATE.md) + +## Variables + +- [ADD](variables/ADD.md) +- [CHANGE](variables/CHANGE.md) +- [CONNECT](variables/CONNECT.md) +- [DELETE](variables/DELETE.md) +- [ERROR](variables/ERROR.md) +- [UPDATE](variables/UPDATE.md) + +## Functions + +- [makeInformer](functions/makeInformer.md) diff --git a/website/docs/sdk/informer/interfaces/Informer.md b/website/docs/sdk/informer/interfaces/Informer.md new file mode 100644 index 00000000000..06470ae457b --- /dev/null +++ b/website/docs/sdk/informer/interfaces/Informer.md @@ -0,0 +1,121 @@ +# Interface: Informer\ + +Defined in: [src/informer.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L28) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Methods + +### off() + +#### Call Signature + +> **off**(`verb`, `cb`): `void` + +Defined in: [src/informer.ts:31](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L31) + +##### Parameters + +###### verb + +`"add"` \| `"update"` \| `"change"` \| `"delete"` + +###### cb + +[`ObjectCallback`](../type-aliases/ObjectCallback.md)\<`T`\> + +##### Returns + +`void` + +#### Call Signature + +> **off**(`verb`, `cb`): `void` + +Defined in: [src/informer.ts:32](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L32) + +##### Parameters + +###### verb + +`"connect"` \| `"error"` + +###### cb + +[`ErrorCallback`](../type-aliases/ErrorCallback.md) + +##### Returns + +`void` + +*** + +### on() + +#### Call Signature + +> **on**(`verb`, `cb`): `void` + +Defined in: [src/informer.ts:29](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L29) + +##### Parameters + +###### verb + +`"add"` \| `"update"` \| `"change"` \| `"delete"` + +###### cb + +[`ObjectCallback`](../type-aliases/ObjectCallback.md)\<`T`\> + +##### Returns + +`void` + +#### Call Signature + +> **on**(`verb`, `cb`): `void` + +Defined in: [src/informer.ts:30](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L30) + +##### Parameters + +###### verb + +`"connect"` \| `"error"` + +###### cb + +[`ErrorCallback`](../type-aliases/ErrorCallback.md) + +##### Returns + +`void` + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [src/informer.ts:33](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L33) + +#### Returns + +`Promise`\<`void`\> + +*** + +### stop() + +> **stop**(): `Promise`\<`void`\> + +Defined in: [src/informer.ts:34](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L34) + +#### Returns + +`Promise`\<`void`\> diff --git a/website/docs/sdk/informer/type-aliases/ADD.md b/website/docs/sdk/informer/type-aliases/ADD.md new file mode 100644 index 00000000000..7194326e2b4 --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/ADD.md @@ -0,0 +1,5 @@ +# Type Alias: ADD + +> **ADD** = *typeof* [`ADD`](../variables/ADD.md) + +Defined in: [src/informer.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L12) diff --git a/website/docs/sdk/informer/type-aliases/CHANGE.md b/website/docs/sdk/informer/type-aliases/CHANGE.md new file mode 100644 index 00000000000..eba2b6d992f --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/CHANGE.md @@ -0,0 +1,5 @@ +# Type Alias: CHANGE + +> **CHANGE** = *typeof* [`CHANGE`](../variables/CHANGE.md) + +Defined in: [src/informer.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L16) diff --git a/website/docs/sdk/informer/type-aliases/CONNECT.md b/website/docs/sdk/informer/type-aliases/CONNECT.md new file mode 100644 index 00000000000..23b4eeffa9d --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/CONNECT.md @@ -0,0 +1,5 @@ +# Type Alias: CONNECT + +> **CONNECT** = *typeof* [`CONNECT`](../variables/CONNECT.md) + +Defined in: [src/informer.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L22) diff --git a/website/docs/sdk/informer/type-aliases/DELETE.md b/website/docs/sdk/informer/type-aliases/DELETE.md new file mode 100644 index 00000000000..7bdd5eb6f36 --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/DELETE.md @@ -0,0 +1,5 @@ +# Type Alias: DELETE + +> **DELETE** = *typeof* [`DELETE`](../variables/DELETE.md) + +Defined in: [src/informer.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L18) diff --git a/website/docs/sdk/informer/type-aliases/ERROR.md b/website/docs/sdk/informer/type-aliases/ERROR.md new file mode 100644 index 00000000000..7ce19f01d3b --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/ERROR.md @@ -0,0 +1,5 @@ +# Type Alias: ERROR + +> **ERROR** = *typeof* [`ERROR`](../variables/ERROR.md) + +Defined in: [src/informer.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L25) diff --git a/website/docs/sdk/informer/type-aliases/ErrorCallback.md b/website/docs/sdk/informer/type-aliases/ErrorCallback.md new file mode 100644 index 00000000000..689f8610d9e --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/ErrorCallback.md @@ -0,0 +1,15 @@ +# Type Alias: ErrorCallback + +> **ErrorCallback** = (`err?`) => `void` + +Defined in: [src/informer.ts:7](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L7) + +## Parameters + +### err? + +`any` + +## Returns + +`void` diff --git a/website/docs/sdk/informer/type-aliases/ListCallback.md b/website/docs/sdk/informer/type-aliases/ListCallback.md new file mode 100644 index 00000000000..561f3606c53 --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/ListCallback.md @@ -0,0 +1,25 @@ +# Type Alias: ListCallback\ + +> **ListCallback**\<`T`\> = (`list`, `ResourceVersion`) => `void` + +Defined in: [src/informer.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L8) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### list + +`T`[] + +### ResourceVersion + +`string` + +## Returns + +`void` diff --git a/website/docs/sdk/informer/type-aliases/ListPromise.md b/website/docs/sdk/informer/type-aliases/ListPromise.md new file mode 100644 index 00000000000..c7ebc97c42e --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/ListPromise.md @@ -0,0 +1,15 @@ +# Type Alias: ListPromise\ + +> **ListPromise**\<`T`\> = () => `Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> + +Defined in: [src/informer.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L9) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Returns + +`Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> diff --git a/website/docs/sdk/informer/type-aliases/ObjectCallback.md b/website/docs/sdk/informer/type-aliases/ObjectCallback.md new file mode 100644 index 00000000000..987c3c41358 --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/ObjectCallback.md @@ -0,0 +1,21 @@ +# Type Alias: ObjectCallback\ + +> **ObjectCallback**\<`T`\> = (`obj`) => `void` + +Defined in: [src/informer.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L6) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### obj + +`T` + +## Returns + +`void` diff --git a/website/docs/sdk/informer/type-aliases/UPDATE.md b/website/docs/sdk/informer/type-aliases/UPDATE.md new file mode 100644 index 00000000000..0d7390faa94 --- /dev/null +++ b/website/docs/sdk/informer/type-aliases/UPDATE.md @@ -0,0 +1,5 @@ +# Type Alias: UPDATE + +> **UPDATE** = *typeof* [`UPDATE`](../variables/UPDATE.md) + +Defined in: [src/informer.ts:14](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L14) diff --git a/website/docs/sdk/informer/variables/ADD.md b/website/docs/sdk/informer/variables/ADD.md new file mode 100644 index 00000000000..a83d4aa3ef6 --- /dev/null +++ b/website/docs/sdk/informer/variables/ADD.md @@ -0,0 +1,5 @@ +# Variable: ADD + +> `const` **ADD**: `"add"` = `'add'` + +Defined in: [src/informer.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L12) diff --git a/website/docs/sdk/informer/variables/CHANGE.md b/website/docs/sdk/informer/variables/CHANGE.md new file mode 100644 index 00000000000..5756791d1ff --- /dev/null +++ b/website/docs/sdk/informer/variables/CHANGE.md @@ -0,0 +1,5 @@ +# Variable: CHANGE + +> `const` **CHANGE**: `"change"` = `'change'` + +Defined in: [src/informer.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L16) diff --git a/website/docs/sdk/informer/variables/CONNECT.md b/website/docs/sdk/informer/variables/CONNECT.md new file mode 100644 index 00000000000..8e1b6f24bec --- /dev/null +++ b/website/docs/sdk/informer/variables/CONNECT.md @@ -0,0 +1,5 @@ +# Variable: CONNECT + +> `const` **CONNECT**: `"connect"` = `'connect'` + +Defined in: [src/informer.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L22) diff --git a/website/docs/sdk/informer/variables/DELETE.md b/website/docs/sdk/informer/variables/DELETE.md new file mode 100644 index 00000000000..683c0df820c --- /dev/null +++ b/website/docs/sdk/informer/variables/DELETE.md @@ -0,0 +1,5 @@ +# Variable: DELETE + +> `const` **DELETE**: `"delete"` = `'delete'` + +Defined in: [src/informer.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L18) diff --git a/website/docs/sdk/informer/variables/ERROR.md b/website/docs/sdk/informer/variables/ERROR.md new file mode 100644 index 00000000000..11d69ae978b --- /dev/null +++ b/website/docs/sdk/informer/variables/ERROR.md @@ -0,0 +1,5 @@ +# Variable: ERROR + +> `const` **ERROR**: `"error"` = `'error'` + +Defined in: [src/informer.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L25) diff --git a/website/docs/sdk/informer/variables/UPDATE.md b/website/docs/sdk/informer/variables/UPDATE.md new file mode 100644 index 00000000000..4bf0d8c5011 --- /dev/null +++ b/website/docs/sdk/informer/variables/UPDATE.md @@ -0,0 +1,5 @@ +# Variable: UPDATE + +> `const` **UPDATE**: `"update"` = `'update'` + +Defined in: [src/informer.ts:14](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L14) diff --git a/website/docs/sdk/log/classes/Log.md b/website/docs/sdk/log/classes/Log.md new file mode 100644 index 00000000000..fcb23972b65 --- /dev/null +++ b/website/docs/sdk/log/classes/Log.md @@ -0,0 +1,105 @@ +# Class: Log + +Defined in: [src/log.ts:84](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L84) + +## Constructors + +### Constructor + +> **new Log**(`config`): `Log` + +Defined in: [src/log.ts:87](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L87) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +#### Returns + +`Log` + +## Properties + +### config + +> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) + +Defined in: [src/log.ts:85](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L85) + +## Methods + +### log() + +#### Call Signature + +> **log**(`namespace`, `podName`, `containerName`, `stream`, `options?`): `Promise`\<`AbortController`\> + +Defined in: [src/log.ts:91](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L91) + +##### Parameters + +###### namespace + +`string` + +###### podName + +`string` + +###### containerName + +`string` + +###### stream + +`Writable` + +###### options? + +[`LogOptions`](../interfaces/LogOptions.md) + +##### Returns + +`Promise`\<`AbortController`\> + +#### Call Signature + +> **log**(`namespace`, `podName`, `containerName`, `stream`, `done`, `options?`): `Promise`\<`AbortController`\> + +Defined in: [src/log.ts:99](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L99) + +##### Parameters + +###### namespace + +`string` + +###### podName + +`string` + +###### containerName + +`string` + +###### stream + +`Writable` + +###### done + +(`err`) => `void` + +###### options? + +[`LogOptions`](../interfaces/LogOptions.md) + +##### Returns + +`Promise`\<`AbortController`\> + +##### Deprecated + +done callback is deprecated diff --git a/website/docs/sdk/log/functions/AddOptionsToSearchParams.md b/website/docs/sdk/log/functions/AddOptionsToSearchParams.md new file mode 100644 index 00000000000..5d6929f3979 --- /dev/null +++ b/website/docs/sdk/log/functions/AddOptionsToSearchParams.md @@ -0,0 +1,19 @@ +# Function: AddOptionsToSearchParams() + +> **AddOptionsToSearchParams**(`options`, `searchParams`): `URLSearchParams` \| `undefined` + +Defined in: [src/log.ts:55](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L55) + +## Parameters + +### options + +[`LogOptions`](../interfaces/LogOptions.md) \| `undefined` + +### searchParams + +`URLSearchParams` + +## Returns + +`URLSearchParams` \| `undefined` diff --git a/website/docs/sdk/log/index.md b/website/docs/sdk/log/index.md new file mode 100644 index 00000000000..fd0405bfa4d --- /dev/null +++ b/website/docs/sdk/log/index.md @@ -0,0 +1,13 @@ +# log + +## Classes + +- [Log](classes/Log.md) + +## Interfaces + +- [LogOptions](interfaces/LogOptions.md) + +## Functions + +- [AddOptionsToSearchParams](functions/AddOptionsToSearchParams.md) diff --git a/website/docs/sdk/log/interfaces/LogOptions.md b/website/docs/sdk/log/interfaces/LogOptions.md new file mode 100644 index 00000000000..d37cbd841cc --- /dev/null +++ b/website/docs/sdk/log/interfaces/LogOptions.md @@ -0,0 +1,88 @@ +# Interface: LogOptions + +Defined in: [src/log.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L8) + +## Properties + +### follow? + +> `optional` **follow?**: `boolean` + +Defined in: [src/log.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L12) + +Follow the log stream of the pod. Defaults to false. + +*** + +### limitBytes? + +> `optional` **limitBytes?**: `number` + +Defined in: [src/log.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L18) + +If set, the number of bytes to read from the server before terminating the log output. This may not display a +complete final line of logging, and may return slightly more or slightly less than the specified limit. + +*** + +### pretty? + +> `optional` **pretty?**: `boolean` + +Defined in: [src/log.ts:23](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L23) + +If true, then the output is pretty printed. + +*** + +### previous? + +> `optional` **previous?**: `boolean` + +Defined in: [src/log.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L28) + +Return previous terminated container logs. Defaults to false. + +*** + +### sinceSeconds? + +> `optional` **sinceSeconds?**: `number` + +Defined in: [src/log.ts:35](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L35) + +A relative time in seconds before the current time from which to show logs. If this value precedes the time a +pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will +be returned. Only one of sinceSeconds or sinceTime may be specified. + +*** + +### sinceTime? + +> `optional` **sinceTime?**: `string` + +Defined in: [src/log.ts:41](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L41) + +Only return logs after a specific date (RFC3339). Defaults to all logs. +Only one of sinceSeconds or sinceTime may be specified. + +*** + +### tailLines? + +> `optional` **tailLines?**: `number` + +Defined in: [src/log.ts:47](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L47) + +If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation +of the container or sinceSeconds or sinceTime + +*** + +### timestamps? + +> `optional` **timestamps?**: `boolean` + +Defined in: [src/log.ts:52](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L52) + +If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. diff --git a/website/docs/sdk/metrics/classes/Metrics.md b/website/docs/sdk/metrics/classes/Metrics.md new file mode 100644 index 00000000000..d635ba0a9c9 --- /dev/null +++ b/website/docs/sdk/metrics/classes/Metrics.md @@ -0,0 +1,51 @@ +# Class: Metrics + +Defined in: [src/metrics.ts:57](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L57) + +## Constructors + +### Constructor + +> **new Metrics**(`config`): `Metrics` + +Defined in: [src/metrics.ts:60](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L60) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +#### Returns + +`Metrics` + +## Methods + +### getNodeMetrics() + +> **getNodeMetrics**(): `Promise`\<[`NodeMetricsList`](../interfaces/NodeMetricsList.md)\> + +Defined in: [src/metrics.ts:64](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L64) + +#### Returns + +`Promise`\<[`NodeMetricsList`](../interfaces/NodeMetricsList.md)\> + +*** + +### getPodMetrics() + +> **getPodMetrics**(`namespace?`): `Promise`\<[`PodMetricsList`](../interfaces/PodMetricsList.md)\> + +Defined in: [src/metrics.ts:68](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L68) + +#### Parameters + +##### namespace? + +`string` + +#### Returns + +`Promise`\<[`PodMetricsList`](../interfaces/PodMetricsList.md)\> diff --git a/website/docs/sdk/metrics/index.md b/website/docs/sdk/metrics/index.md new file mode 100644 index 00000000000..21d120f931e --- /dev/null +++ b/website/docs/sdk/metrics/index.md @@ -0,0 +1,14 @@ +# metrics + +## Classes + +- [Metrics](classes/Metrics.md) + +## Interfaces + +- [ContainerMetric](interfaces/ContainerMetric.md) +- [NodeMetric](interfaces/NodeMetric.md) +- [NodeMetricsList](interfaces/NodeMetricsList.md) +- [PodMetric](interfaces/PodMetric.md) +- [PodMetricsList](interfaces/PodMetricsList.md) +- [Usage](interfaces/Usage.md) diff --git a/website/docs/sdk/metrics/interfaces/ContainerMetric.md b/website/docs/sdk/metrics/interfaces/ContainerMetric.md new file mode 100644 index 00000000000..af8a60e11ef --- /dev/null +++ b/website/docs/sdk/metrics/interfaces/ContainerMetric.md @@ -0,0 +1,19 @@ +# Interface: ContainerMetric + +Defined in: [src/metrics.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L11) + +## Properties + +### name + +> **name**: `string` + +Defined in: [src/metrics.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L12) + +*** + +### usage + +> **usage**: [`Usage`](Usage.md) + +Defined in: [src/metrics.ts:13](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L13) diff --git a/website/docs/sdk/metrics/interfaces/NodeMetric.md b/website/docs/sdk/metrics/interfaces/NodeMetric.md new file mode 100644 index 00000000000..5fdd68e52d0 --- /dev/null +++ b/website/docs/sdk/metrics/interfaces/NodeMetric.md @@ -0,0 +1,47 @@ +# Interface: NodeMetric + +Defined in: [src/metrics.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L28) + +## Properties + +### metadata + +> **metadata**: `object` + +Defined in: [src/metrics.ts:29](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L29) + +#### creationTimestamp + +> **creationTimestamp**: `string` + +#### name + +> **name**: `string` + +#### selfLink + +> **selfLink**: `string` + +*** + +### timestamp + +> **timestamp**: `string` + +Defined in: [src/metrics.ts:34](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L34) + +*** + +### usage + +> **usage**: [`Usage`](Usage.md) + +Defined in: [src/metrics.ts:36](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L36) + +*** + +### window + +> **window**: `string` + +Defined in: [src/metrics.ts:35](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L35) diff --git a/website/docs/sdk/metrics/interfaces/NodeMetricsList.md b/website/docs/sdk/metrics/interfaces/NodeMetricsList.md new file mode 100644 index 00000000000..ebee94d3a88 --- /dev/null +++ b/website/docs/sdk/metrics/interfaces/NodeMetricsList.md @@ -0,0 +1,39 @@ +# Interface: NodeMetricsList + +Defined in: [src/metrics.ts:48](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L48) + +## Properties + +### apiVersion + +> **apiVersion**: `"metrics.k8s.io/v1beta1"` + +Defined in: [src/metrics.ts:50](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L50) + +*** + +### items + +> **items**: [`NodeMetric`](NodeMetric.md)[] + +Defined in: [src/metrics.ts:54](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L54) + +*** + +### kind + +> **kind**: `"NodeMetricsList"` + +Defined in: [src/metrics.ts:49](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L49) + +*** + +### metadata + +> **metadata**: `object` + +Defined in: [src/metrics.ts:51](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L51) + +#### selfLink + +> **selfLink**: `string` diff --git a/website/docs/sdk/metrics/interfaces/PodMetric.md b/website/docs/sdk/metrics/interfaces/PodMetric.md new file mode 100644 index 00000000000..9e664b1b9ea --- /dev/null +++ b/website/docs/sdk/metrics/interfaces/PodMetric.md @@ -0,0 +1,51 @@ +# Interface: PodMetric + +Defined in: [src/metrics.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L16) + +## Properties + +### containers + +> **containers**: [`ContainerMetric`](ContainerMetric.md)[] + +Defined in: [src/metrics.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L25) + +*** + +### metadata + +> **metadata**: `object` + +Defined in: [src/metrics.ts:17](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L17) + +#### creationTimestamp + +> **creationTimestamp**: `string` + +#### name + +> **name**: `string` + +#### namespace + +> **namespace**: `string` + +#### selfLink + +> **selfLink**: `string` + +*** + +### timestamp + +> **timestamp**: `string` + +Defined in: [src/metrics.ts:23](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L23) + +*** + +### window + +> **window**: `string` + +Defined in: [src/metrics.ts:24](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L24) diff --git a/website/docs/sdk/metrics/interfaces/PodMetricsList.md b/website/docs/sdk/metrics/interfaces/PodMetricsList.md new file mode 100644 index 00000000000..338d19239ee --- /dev/null +++ b/website/docs/sdk/metrics/interfaces/PodMetricsList.md @@ -0,0 +1,39 @@ +# Interface: PodMetricsList + +Defined in: [src/metrics.ts:39](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L39) + +## Properties + +### apiVersion + +> **apiVersion**: `"metrics.k8s.io/v1beta1"` + +Defined in: [src/metrics.ts:41](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L41) + +*** + +### items + +> **items**: [`PodMetric`](PodMetric.md)[] + +Defined in: [src/metrics.ts:45](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L45) + +*** + +### kind + +> **kind**: `"PodMetricsList"` + +Defined in: [src/metrics.ts:40](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L40) + +*** + +### metadata + +> **metadata**: `object` + +Defined in: [src/metrics.ts:42](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L42) + +#### selfLink + +> **selfLink**: `string` diff --git a/website/docs/sdk/metrics/interfaces/Usage.md b/website/docs/sdk/metrics/interfaces/Usage.md new file mode 100644 index 00000000000..0f04f4ca098 --- /dev/null +++ b/website/docs/sdk/metrics/interfaces/Usage.md @@ -0,0 +1,19 @@ +# Interface: Usage + +Defined in: [src/metrics.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L6) + +## Properties + +### cpu + +> **cpu**: `string` + +Defined in: [src/metrics.ts:7](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L7) + +*** + +### memory + +> **memory**: `string` + +Defined in: [src/metrics.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L8) diff --git a/website/docs/sdk/middleware/functions/setHeaderMiddleware.md b/website/docs/sdk/middleware/functions/setHeaderMiddleware.md new file mode 100644 index 00000000000..8d035ae59eb --- /dev/null +++ b/website/docs/sdk/middleware/functions/setHeaderMiddleware.md @@ -0,0 +1,19 @@ +# Function: setHeaderMiddleware() + +> **setHeaderMiddleware**(`key`, `value`): `Middleware` + +Defined in: [src/middleware.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/middleware.ts#L9) + +## Parameters + +### key + +`string` + +### value + +`string` + +## Returns + +`Middleware` diff --git a/website/docs/sdk/middleware/functions/setHeaderOptions.md b/website/docs/sdk/middleware/functions/setHeaderOptions.md new file mode 100644 index 00000000000..16600846d2e --- /dev/null +++ b/website/docs/sdk/middleware/functions/setHeaderOptions.md @@ -0,0 +1,23 @@ +# Function: setHeaderOptions() + +> **setHeaderOptions**(`key`, `value`, `opt?`): `ConfigurationOptions`\<`Middleware`\> + +Defined in: [src/middleware.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/middleware.ts#L22) + +## Parameters + +### key + +`string` + +### value + +`string` + +### opt? + +`ConfigurationOptions`\<`Middleware`\> + +## Returns + +`ConfigurationOptions`\<`Middleware`\> diff --git a/website/docs/sdk/middleware/index.md b/website/docs/sdk/middleware/index.md new file mode 100644 index 00000000000..cffdb06008c --- /dev/null +++ b/website/docs/sdk/middleware/index.md @@ -0,0 +1,6 @@ +# middleware + +## Functions + +- [setHeaderMiddleware](functions/setHeaderMiddleware.md) +- [setHeaderOptions](functions/setHeaderOptions.md) diff --git a/website/docs/sdk/object/classes/KubernetesObjectApi.md b/website/docs/sdk/object/classes/KubernetesObjectApi.md new file mode 100644 index 00000000000..8076aba4eb0 --- /dev/null +++ b/website/docs/sdk/object/classes/KubernetesObjectApi.md @@ -0,0 +1,466 @@ +# Class: KubernetesObjectApi + +Defined in: [src/object.ts:37](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L37) + +Dynamically construct Kubernetes API request URIs so client does not have to know what type of object it is acting +on. + +## Constructors + +### Constructor + +> **new KubernetesObjectApi**(`configuration`): `KubernetesObjectApi` + +Defined in: [src/object.ts:59](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L59) + +#### Parameters + +##### configuration + +`Configuration` + +#### Returns + +`KubernetesObjectApi` + +## Methods + +### create() + +> **create**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `options?`): `Promise`\<`T`\> + +Defined in: [src/object.ts:76](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L76) + +Create any Kubernetes resource. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### spec + +`T` + +Kubernetes resource spec. + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### dryRun? + +`string` + +When present, indicates that modifications should not be persisted. An invalid or unrecognized + dryRun directive will result in an error response and no further processing of the request. Valid values + are: - All: all dry run stages will be processed + +##### fieldManager? + +`string` + +fieldManager is a name associated with the actor or entity that is making these changes. The + value must be less than or 128 characters long, and only contain printable characters, as defined by + https://golang.org/pkg/unicode/#IsPrint. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`T`\> + +Promise containing the request response and [[KubernetesObject]]. + +*** + +### delete() + +> **delete**(`spec`, `pretty?`, `dryRun?`, `gracePeriodSeconds?`, `orphanDependents?`, `propagationPolicy?`, `body?`, `options?`): `Promise`\<`V1Status`\> + +Defined in: [src/object.ts:145](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L145) + +Delete any Kubernetes resource. + +#### Parameters + +##### spec + +[`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +Kubernetes resource spec + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### dryRun? + +`string` + +When present, indicates that modifications should not be persisted. An invalid or unrecognized + dryRun directive will result in an error response and no further processing of the request. Valid values + are: - All: all dry run stages will be processed + +##### gracePeriodSeconds? + +`number` + +The duration in seconds before the object should be deleted. Value must be non-negative + integer. The value zero indicates delete immediately. If this value is nil, the default grace period for + the specified type will be used. Defaults to a per object value if not specified. zero means delete + immediately. + +##### orphanDependents? + +`boolean` + +Deprecated: please use the PropagationPolicy, this field will be deprecated in + 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be + added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be + set, but not both. + +##### propagationPolicy? + +`string` + +Whether and how garbage collection will be performed. Either this field or + OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in + the metadata.finalizers and the resource-specific default policy. Acceptable values are: + \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete + the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents + in the foreground. + +##### body? + +`V1DeleteOptions` + +See [[V1DeleteOptions]]. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`V1Status`\> + +Promise containing the request response and a Kubernetes [[V1Status]]. + +*** + +### list() + +> **list**\<`T`\>(`apiVersion`, `kind`, `namespace?`, `pretty?`, `exact?`, `exportt?`, `fieldSelector?`, `labelSelector?`, `limit?`, `continueToken?`, `options?`): `Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> + +Defined in: [src/object.ts:349](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L349) + +List any Kubernetes resources. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### apiVersion + +`string` + +api group and version of the form / + +##### kind + +`string` + +Kubernetes resource kind + +##### namespace? + +`string` + +list resources in this namespace + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### exact? + +`boolean` + +Should the export be exact. Exact export maintains cluster-specific fields like + \'Namespace\'. Deprecated. Planned for removal in 1.18. + +##### exportt? + +`boolean` + +Should this value be exported. Export strips fields that a user can not + specify. Deprecated. Planned for removal in 1.18. + +##### fieldSelector? + +`string` + +A selector to restrict the list of returned objects by their fields. Defaults to everything. + +##### labelSelector? + +`string` + +A selector to restrict the list of returned objects by their labels. Defaults to everything. + +##### limit? + +`number` + +Number of returned resources. + +##### continueToken? + +`string` + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> + +Promise containing the request response and [[KubernetesListObject]]. + +*** + +### patch() + +> **patch**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `force?`, `patchStrategy?`, `options?`): `Promise`\<`T`\> + +Defined in: [src/object.ts:230](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L230) + +Patch any Kubernetes resource. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### spec + +`T` + +Kubernetes resource spec + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### dryRun? + +`string` + +When present, indicates that modifications should not be persisted. An invalid or unrecognized + dryRun directive will result in an error response and no further processing of the request. Valid values + are: - All: all dry run stages will be processed + +##### fieldManager? + +`string` + +fieldManager is a name associated with the actor or entity that is making these changes. The + value must be less than or 128 characters long, and only contain printable characters, as defined by + https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests + (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, + StrategicMergePatch). + +##### force? + +`boolean` + +Force is going to \"force\" Apply requests. It means user will re-acquire conflicting + fields owned by other people. Force flag must be unset for non-apply patch requests. + +##### patchStrategy? + +[`PatchStrategy`](../../patch/type-aliases/PatchStrategy.md) = `PatchStrategy.StrategicMergePatch` + +Content-Type header used to control how the patch will be performed. See + See https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ + for details. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`T`\> + +Promise containing the request response and [[KubernetesObject]]. + +*** + +### read() + +> **read**\<`T`\>(`spec`, `pretty?`, `exact?`, `exportt?`, `options?`): `Promise`\<`T`\> + +Defined in: [src/object.ts:292](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L292) + +Read any Kubernetes resource. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### spec + +`KubernetesObjectHeader`\<`T`\> + +Kubernetes resource spec + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### exact? + +`boolean` + +Should the export be exact. Exact export maintains cluster-specific fields like + \'Namespace\'. Deprecated. Planned for removal in 1.18. + +##### exportt? + +`boolean` + +Should this value be exported. Export strips fields that a user can not + specify. Deprecated. Planned for removal in 1.18. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`T`\> + +Promise containing the request response and [[KubernetesObject]]. + +*** + +### replace() + +> **replace**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `options?`): `Promise`\<`T`\> + +Defined in: [src/object.ts:436](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L436) + +Replace any Kubernetes resource. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### spec + +`T` + +Kubernetes resource spec + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### dryRun? + +`string` + +When present, indicates that modifications should not be persisted. An invalid or unrecognized + dryRun directive will result in an error response and no further processing of the request. Valid values + are: - All: all dry run stages will be processed + +##### fieldManager? + +`string` + +fieldManager is a name associated with the actor or entity that is making these changes. The + value must be less than or 128 characters long, and only contain printable characters, as defined by + https://golang.org/pkg/unicode/#IsPrint. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`T`\> + +Promise containing the request response and [[KubernetesObject]]. + +*** + +### makeApiClient() + +> `static` **makeApiClient**(`kc`): `KubernetesObjectApi` + +Defined in: [src/object.ts:46](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L46) + +Create a KubernetesObjectApi object from the provided KubeConfig. This method should be used rather than +[[KubeConfig.makeApiClient]] so we can properly determine the default namespace if one is provided by the current +context. + +#### Parameters + +##### kc + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +Valid Kubernetes config + +#### Returns + +`KubernetesObjectApi` + +Properly instantiated [[KubernetesObjectApi]] object diff --git a/website/docs/sdk/object/index.md b/website/docs/sdk/object/index.md new file mode 100644 index 00000000000..82633830a1e --- /dev/null +++ b/website/docs/sdk/object/index.md @@ -0,0 +1,5 @@ +# object + +## Classes + +- [KubernetesObjectApi](classes/KubernetesObjectApi.md) diff --git a/website/docs/sdk/patch/index.md b/website/docs/sdk/patch/index.md new file mode 100644 index 00000000000..33a10aae72b --- /dev/null +++ b/website/docs/sdk/patch/index.md @@ -0,0 +1,9 @@ +# patch + +## Type Aliases + +- [PatchStrategy](type-aliases/PatchStrategy.md) + +## Variables + +- [PatchStrategy](variables/PatchStrategy.md) diff --git a/website/docs/sdk/patch/type-aliases/PatchStrategy.md b/website/docs/sdk/patch/type-aliases/PatchStrategy.md new file mode 100644 index 00000000000..8ca2a4a25f1 --- /dev/null +++ b/website/docs/sdk/patch/type-aliases/PatchStrategy.md @@ -0,0 +1,12 @@ +# Type Alias: PatchStrategy + +> **PatchStrategy** = *typeof* [`PatchStrategy`](../variables/PatchStrategy.md)\[keyof *typeof* [`PatchStrategy`](../variables/PatchStrategy.md)\] + +Defined in: [src/patch.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/patch.ts#L9) + +Valid Content-Type header values for patch operations. See +https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +for details. + +Additionally for Server-Side Apply https://kubernetes.io/docs/reference/using-api/server-side-apply/ +and https://kubernetes.io/docs/reference/using-api/server-side-apply/#api-implementation diff --git a/website/docs/sdk/patch/variables/PatchStrategy.md b/website/docs/sdk/patch/variables/PatchStrategy.md new file mode 100644 index 00000000000..599906fec57 --- /dev/null +++ b/website/docs/sdk/patch/variables/PatchStrategy.md @@ -0,0 +1,38 @@ +# Variable: PatchStrategy + +> `const` **PatchStrategy**: `object` + +Defined in: [src/patch.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/patch.ts#L9) + +Valid Content-Type header values for patch operations. See +https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +for details. + +Additionally for Server-Side Apply https://kubernetes.io/docs/reference/using-api/server-side-apply/ +and https://kubernetes.io/docs/reference/using-api/server-side-apply/#api-implementation + +## Type Declaration + +### JsonPatch + +> `readonly` **JsonPatch**: `"application/json-patch+json"` = `'application/json-patch+json'` + +Diff-like JSON format. + +### MergePatch + +> `readonly` **MergePatch**: `"application/merge-patch+json"` = `'application/merge-patch+json'` + +Simple merge. + +### ServerSideApply + +> `readonly` **ServerSideApply**: `"application/apply-patch+yaml"` = `'application/apply-patch+yaml'` + +Server-Side Apply + +### StrategicMergePatch + +> `readonly` **StrategicMergePatch**: `"application/strategic-merge-patch+json"` = `'application/strategic-merge-patch+json'` + +Merge with different strategies depending on field metadata. diff --git a/website/docs/sdk/portforward/classes/PortForward.md b/website/docs/sdk/portforward/classes/PortForward.md new file mode 100644 index 00000000000..36f581c6015 --- /dev/null +++ b/website/docs/sdk/portforward/classes/PortForward.md @@ -0,0 +1,195 @@ +# Class: PortForward + +Defined in: [src/portforward.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L9) + +## Constructors + +### Constructor + +> **new PortForward**(`config`, `disconnectOnErr?`, `handler?`): `PortForward` + +Defined in: [src/portforward.ts:15](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L15) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +##### disconnectOnErr? + +`boolean` + +##### handler? + +`WebSocketInterface` + +#### Returns + +`PortForward` + +## Methods + +### portForward() + +> **portForward**(`namespace`, `podName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> + +Defined in: [src/portforward.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L22) + +#### Parameters + +##### namespace + +`string` + +##### podName + +`string` + +##### targetPorts + +`number`[] + +##### output + +`Writable` + +##### err + +`Writable` \| `null` + +##### input + +`Readable` + +##### retryCount? + +`number` = `0` + +#### Returns + +`Promise`\<`any`\> + +*** + +### portForwardDeployment() + +> **portForwardDeployment**(`namespace`, `deploymentName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> + +Defined in: [src/portforward.ts:123](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L123) + +Port forward to a deployment by resolving to the first ready pod selected by the deployment's selector. + +#### Parameters + +##### namespace + +`string` + +The namespace of the deployment + +##### deploymentName + +`string` + +The name of the deployment + +##### targetPorts + +`number`[] + +The target ports to forward to + +##### output + +`Writable` + +The writable stream for output + +##### err + +`Writable` \| `null` + +The writable stream for error output (can be null) + +##### input + +`Readable` + +The readable stream for input + +##### retryCount? + +`number` = `0` + +The number of times to retry the connection + +#### Returns + +`Promise`\<`any`\> + +#### Throws + +Will throw an error if the deployment is not found or has no ready pods + +*** + +### portForwardService() + +> **portForwardService**(`namespace`, `serviceName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> + +Defined in: [src/portforward.ts:89](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L89) + +Port forward to a service by resolving to the first ready pod selected by the service's selector. + +#### Parameters + +##### namespace + +`string` + +The namespace of the service + +##### serviceName + +`string` + +The name of the service + +##### targetPorts + +`number`[] + +The target ports to forward to + +##### output + +`Writable` + +The writable stream for output + +##### err + +`Writable` \| `null` + +The writable stream for error output (can be null) + +##### input + +`Readable` + +The readable stream for input + +##### retryCount? + +`number` = `0` + +The number of times to retry the connection + +#### Returns + +`Promise`\<`any`\> + +#### Throws + +Will throw an error if the service is not found or has no ready pods diff --git a/website/docs/sdk/portforward/index.md b/website/docs/sdk/portforward/index.md new file mode 100644 index 00000000000..5330431e384 --- /dev/null +++ b/website/docs/sdk/portforward/index.md @@ -0,0 +1,5 @@ +# portforward + +## Classes + +- [PortForward](classes/PortForward.md) diff --git a/website/docs/sdk/top/classes/ContainerStatus.md b/website/docs/sdk/top/classes/ContainerStatus.md new file mode 100644 index 00000000000..eec54601d3b --- /dev/null +++ b/website/docs/sdk/top/classes/ContainerStatus.md @@ -0,0 +1,53 @@ +# Class: ContainerStatus + +Defined in: [src/top.ts:49](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L49) + +## Constructors + +### Constructor + +> **new ContainerStatus**(`Container`, `CPUUsage`, `MemoryUsage`): `ContainerStatus` + +Defined in: [src/top.ts:54](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L54) + +#### Parameters + +##### Container + +`string` + +##### CPUUsage + +[`CurrentResourceUsage`](CurrentResourceUsage.md) + +##### MemoryUsage + +[`CurrentResourceUsage`](CurrentResourceUsage.md) + +#### Returns + +`ContainerStatus` + +## Properties + +### Container + +> `readonly` **Container**: `string` + +Defined in: [src/top.ts:50](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L50) + +*** + +### CPUUsage + +> `readonly` **CPUUsage**: [`CurrentResourceUsage`](CurrentResourceUsage.md) + +Defined in: [src/top.ts:51](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L51) + +*** + +### MemoryUsage + +> `readonly` **MemoryUsage**: [`CurrentResourceUsage`](CurrentResourceUsage.md) + +Defined in: [src/top.ts:52](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L52) diff --git a/website/docs/sdk/top/classes/CurrentResourceUsage.md b/website/docs/sdk/top/classes/CurrentResourceUsage.md new file mode 100644 index 00000000000..b8fbff0001d --- /dev/null +++ b/website/docs/sdk/top/classes/CurrentResourceUsage.md @@ -0,0 +1,53 @@ +# Class: CurrentResourceUsage + +Defined in: [src/top.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L25) + +## Constructors + +### Constructor + +> **new CurrentResourceUsage**(`CurrentUsage`, `RequestTotal`, `LimitTotal`): `CurrentResourceUsage` + +Defined in: [src/top.ts:30](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L30) + +#### Parameters + +##### CurrentUsage + +`number` \| `bigint` + +##### RequestTotal + +`number` \| `bigint` + +##### LimitTotal + +`number` \| `bigint` + +#### Returns + +`CurrentResourceUsage` + +## Properties + +### CurrentUsage + +> `readonly` **CurrentUsage**: `number` \| `bigint` + +Defined in: [src/top.ts:26](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L26) + +*** + +### LimitTotal + +> `readonly` **LimitTotal**: `number` \| `bigint` + +Defined in: [src/top.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L28) + +*** + +### RequestTotal + +> `readonly` **RequestTotal**: `number` \| `bigint` + +Defined in: [src/top.ts:27](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L27) diff --git a/website/docs/sdk/top/classes/NodeStatus.md b/website/docs/sdk/top/classes/NodeStatus.md new file mode 100644 index 00000000000..2ef996fa6a5 --- /dev/null +++ b/website/docs/sdk/top/classes/NodeStatus.md @@ -0,0 +1,53 @@ +# Class: NodeStatus + +Defined in: [src/top.ts:37](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L37) + +## Constructors + +### Constructor + +> **new NodeStatus**(`Node`, `CPU`, `Memory`): `NodeStatus` + +Defined in: [src/top.ts:42](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L42) + +#### Parameters + +##### Node + +`V1Node` + +##### CPU + +[`ResourceUsage`](ResourceUsage.md) + +##### Memory + +[`ResourceUsage`](ResourceUsage.md) + +#### Returns + +`NodeStatus` + +## Properties + +### CPU + +> `readonly` **CPU**: [`ResourceUsage`](ResourceUsage.md) + +Defined in: [src/top.ts:39](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L39) + +*** + +### Memory + +> `readonly` **Memory**: [`ResourceUsage`](ResourceUsage.md) + +Defined in: [src/top.ts:40](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L40) + +*** + +### Node + +> `readonly` **Node**: `V1Node` + +Defined in: [src/top.ts:38](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L38) diff --git a/website/docs/sdk/top/classes/PodStatus.md b/website/docs/sdk/top/classes/PodStatus.md new file mode 100644 index 00000000000..e86261de776 --- /dev/null +++ b/website/docs/sdk/top/classes/PodStatus.md @@ -0,0 +1,65 @@ +# Class: PodStatus + +Defined in: [src/top.ts:61](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L61) + +## Constructors + +### Constructor + +> **new PodStatus**(`Pod`, `CPU`, `Memory`, `Containers`): `PodStatus` + +Defined in: [src/top.ts:67](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L67) + +#### Parameters + +##### Pod + +`V1Pod` + +##### CPU + +[`CurrentResourceUsage`](CurrentResourceUsage.md) + +##### Memory + +[`CurrentResourceUsage`](CurrentResourceUsage.md) + +##### Containers + +[`ContainerStatus`](ContainerStatus.md)[] + +#### Returns + +`PodStatus` + +## Properties + +### Containers + +> `readonly` **Containers**: [`ContainerStatus`](ContainerStatus.md)[] + +Defined in: [src/top.ts:65](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L65) + +*** + +### CPU + +> `readonly` **CPU**: [`CurrentResourceUsage`](CurrentResourceUsage.md) + +Defined in: [src/top.ts:63](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L63) + +*** + +### Memory + +> `readonly` **Memory**: [`CurrentResourceUsage`](CurrentResourceUsage.md) + +Defined in: [src/top.ts:64](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L64) + +*** + +### Pod + +> `readonly` **Pod**: `V1Pod` + +Defined in: [src/top.ts:62](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L62) diff --git a/website/docs/sdk/top/classes/ResourceUsage.md b/website/docs/sdk/top/classes/ResourceUsage.md new file mode 100644 index 00000000000..70e2ae3caeb --- /dev/null +++ b/website/docs/sdk/top/classes/ResourceUsage.md @@ -0,0 +1,53 @@ +# Class: ResourceUsage + +Defined in: [src/top.ts:13](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L13) + +## Constructors + +### Constructor + +> **new ResourceUsage**(`Capacity`, `RequestTotal`, `LimitTotal`): `ResourceUsage` + +Defined in: [src/top.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L18) + +#### Parameters + +##### Capacity + +`number` \| `bigint` + +##### RequestTotal + +`number` \| `bigint` + +##### LimitTotal + +`number` \| `bigint` + +#### Returns + +`ResourceUsage` + +## Properties + +### Capacity + +> `readonly` **Capacity**: `number` \| `bigint` + +Defined in: [src/top.ts:14](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L14) + +*** + +### LimitTotal + +> `readonly` **LimitTotal**: `number` \| `bigint` + +Defined in: [src/top.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L16) + +*** + +### RequestTotal + +> `readonly` **RequestTotal**: `number` \| `bigint` + +Defined in: [src/top.ts:15](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L15) diff --git a/website/docs/sdk/top/functions/topNodes.md b/website/docs/sdk/top/functions/topNodes.md new file mode 100644 index 00000000000..d198f3480fc --- /dev/null +++ b/website/docs/sdk/top/functions/topNodes.md @@ -0,0 +1,15 @@ +# Function: topNodes() + +> **topNodes**(`api`): `Promise`\<[`NodeStatus`](../classes/NodeStatus.md)[]\> + +Defined in: [src/top.ts:80](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L80) + +## Parameters + +### api + +`ObjectCoreV1Api` + +## Returns + +`Promise`\<[`NodeStatus`](../classes/NodeStatus.md)[]\> diff --git a/website/docs/sdk/top/functions/topPods.md b/website/docs/sdk/top/functions/topPods.md new file mode 100644 index 00000000000..5424227a4fd --- /dev/null +++ b/website/docs/sdk/top/functions/topPods.md @@ -0,0 +1,23 @@ +# Function: topPods() + +> **topPods**(`api`, `metrics`, `namespace?`): `Promise`\<[`PodStatus`](../classes/PodStatus.md)[]\> + +Defined in: [src/top.ts:111](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L111) + +## Parameters + +### api + +`ObjectCoreV1Api` + +### metrics + +[`Metrics`](../../metrics/classes/Metrics.md) + +### namespace? + +`string` + +## Returns + +`Promise`\<[`PodStatus`](../classes/PodStatus.md)[]\> diff --git a/website/docs/sdk/top/index.md b/website/docs/sdk/top/index.md new file mode 100644 index 00000000000..dda791b768b --- /dev/null +++ b/website/docs/sdk/top/index.md @@ -0,0 +1,14 @@ +# top + +## Classes + +- [ContainerStatus](classes/ContainerStatus.md) +- [CurrentResourceUsage](classes/CurrentResourceUsage.md) +- [NodeStatus](classes/NodeStatus.md) +- [PodStatus](classes/PodStatus.md) +- [ResourceUsage](classes/ResourceUsage.md) + +## Functions + +- [topNodes](functions/topNodes.md) +- [topPods](functions/topPods.md) diff --git a/website/docs/sdk/typedoc-sidebar.cjs b/website/docs/sdk/typedoc-sidebar.cjs new file mode 100644 index 00000000000..575b5c88e97 --- /dev/null +++ b/website/docs/sdk/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ +const typedocSidebar = {items:[{type:"category",label:"attach",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/attach/classes/Attach",label:"Attach"}]}],link:{type:"doc",id:"sdk/attach/index"}},{type:"category",label:"cache",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/cache/classes/ListWatch",label:"ListWatch"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/cache/interfaces/ObjectCache",label:"ObjectCache"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/cache/type-aliases/CacheMap",label:"CacheMap"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/cache/functions/addOrUpdateObject",label:"addOrUpdateObject"},{type:"doc",id:"sdk/cache/functions/cacheMapFromList",label:"cacheMapFromList"},{type:"doc",id:"sdk/cache/functions/deleteItems",label:"deleteItems"},{type:"doc",id:"sdk/cache/functions/deleteObject",label:"deleteObject"}]}],link:{type:"doc",id:"sdk/cache/index"}},{type:"category",label:"config",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/config/classes/KubeConfig",label:"KubeConfig"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/config/interfaces/ApiType",label:"ApiType"},{type:"doc",id:"sdk/config/interfaces/Named",label:"Named"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/config/type-aliases/ApiConstructor",label:"ApiConstructor"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/config/functions/bufferFromFileOrString",label:"bufferFromFileOrString"},{type:"doc",id:"sdk/config/functions/findHomeDir",label:"findHomeDir"},{type:"doc",id:"sdk/config/functions/findObject",label:"findObject"},{type:"doc",id:"sdk/config/functions/makeAbsolutePath",label:"makeAbsolutePath"}]}],link:{type:"doc",id:"sdk/config/index"}},{type:"category",label:"config_types",items:[{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/config_types/interfaces/Cluster",label:"Cluster"},{type:"doc",id:"sdk/config_types/interfaces/ConfigOptions",label:"ConfigOptions"},{type:"doc",id:"sdk/config_types/interfaces/Context",label:"Context"},{type:"doc",id:"sdk/config_types/interfaces/User",label:"User"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/config_types/type-aliases/ActionOnInvalid",label:"ActionOnInvalid"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/config_types/variables/ActionOnInvalid",label:"ActionOnInvalid"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/config_types/functions/exportCluster",label:"exportCluster"},{type:"doc",id:"sdk/config_types/functions/exportContext",label:"exportContext"},{type:"doc",id:"sdk/config_types/functions/exportUser",label:"exportUser"},{type:"doc",id:"sdk/config_types/functions/newClusters",label:"newClusters"},{type:"doc",id:"sdk/config_types/functions/newContexts",label:"newContexts"},{type:"doc",id:"sdk/config_types/functions/newUsers",label:"newUsers"}]}],link:{type:"doc",id:"sdk/config_types/index"}},{type:"category",label:"cp",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/cp/classes/Cp",label:"Cp"}]}],link:{type:"doc",id:"sdk/cp/index"}},{type:"category",label:"exec",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/exec/classes/Exec",label:"Exec"}]}],link:{type:"doc",id:"sdk/exec/index"}},{type:"category",label:"health",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/health/classes/Health",label:"Health"}]}],link:{type:"doc",id:"sdk/health/index"}},{type:"category",label:"informer",items:[{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/informer/interfaces/Informer",label:"Informer"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/informer/type-aliases/ADD",label:"ADD"},{type:"doc",id:"sdk/informer/type-aliases/CHANGE",label:"CHANGE"},{type:"doc",id:"sdk/informer/type-aliases/CONNECT",label:"CONNECT"},{type:"doc",id:"sdk/informer/type-aliases/DELETE",label:"DELETE"},{type:"doc",id:"sdk/informer/type-aliases/ERROR",label:"ERROR"},{type:"doc",id:"sdk/informer/type-aliases/ErrorCallback",label:"ErrorCallback"},{type:"doc",id:"sdk/informer/type-aliases/ListCallback",label:"ListCallback"},{type:"doc",id:"sdk/informer/type-aliases/ListPromise",label:"ListPromise"},{type:"doc",id:"sdk/informer/type-aliases/ObjectCallback",label:"ObjectCallback"},{type:"doc",id:"sdk/informer/type-aliases/UPDATE",label:"UPDATE"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/informer/variables/ADD",label:"ADD"},{type:"doc",id:"sdk/informer/variables/CHANGE",label:"CHANGE"},{type:"doc",id:"sdk/informer/variables/CONNECT",label:"CONNECT"},{type:"doc",id:"sdk/informer/variables/DELETE",label:"DELETE"},{type:"doc",id:"sdk/informer/variables/ERROR",label:"ERROR"},{type:"doc",id:"sdk/informer/variables/UPDATE",label:"UPDATE"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/informer/functions/makeInformer",label:"makeInformer"}]}],link:{type:"doc",id:"sdk/informer/index"}},{type:"category",label:"log",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/log/classes/Log",label:"Log"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/log/interfaces/LogOptions",label:"LogOptions"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/log/functions/AddOptionsToSearchParams",label:"AddOptionsToSearchParams"}]}],link:{type:"doc",id:"sdk/log/index"}},{type:"category",label:"metrics",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/metrics/classes/Metrics",label:"Metrics"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/metrics/interfaces/ContainerMetric",label:"ContainerMetric"},{type:"doc",id:"sdk/metrics/interfaces/NodeMetric",label:"NodeMetric"},{type:"doc",id:"sdk/metrics/interfaces/NodeMetricsList",label:"NodeMetricsList"},{type:"doc",id:"sdk/metrics/interfaces/PodMetric",label:"PodMetric"},{type:"doc",id:"sdk/metrics/interfaces/PodMetricsList",label:"PodMetricsList"},{type:"doc",id:"sdk/metrics/interfaces/Usage",label:"Usage"}]}],link:{type:"doc",id:"sdk/metrics/index"}},{type:"category",label:"middleware",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/middleware/functions/setHeaderMiddleware",label:"setHeaderMiddleware"},{type:"doc",id:"sdk/middleware/functions/setHeaderOptions",label:"setHeaderOptions"}]}],link:{type:"doc",id:"sdk/middleware/index"}},{type:"category",label:"object",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/object/classes/KubernetesObjectApi",label:"KubernetesObjectApi"}]}],link:{type:"doc",id:"sdk/object/index"}},{type:"category",label:"patch",items:[{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/patch/type-aliases/PatchStrategy",label:"PatchStrategy"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/patch/variables/PatchStrategy",label:"PatchStrategy"}]}],link:{type:"doc",id:"sdk/patch/index"}},{type:"category",label:"portforward",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/portforward/classes/PortForward",label:"PortForward"}]}],link:{type:"doc",id:"sdk/portforward/index"}},{type:"category",label:"top",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/top/classes/ContainerStatus",label:"ContainerStatus"},{type:"doc",id:"sdk/top/classes/CurrentResourceUsage",label:"CurrentResourceUsage"},{type:"doc",id:"sdk/top/classes/NodeStatus",label:"NodeStatus"},{type:"doc",id:"sdk/top/classes/PodStatus",label:"PodStatus"},{type:"doc",id:"sdk/top/classes/ResourceUsage",label:"ResourceUsage"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/top/functions/topNodes",label:"topNodes"},{type:"doc",id:"sdk/top/functions/topPods",label:"topPods"}]}],link:{type:"doc",id:"sdk/top/index"}},{type:"category",label:"types",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/types/classes/V1MicroTime",label:"V1MicroTime"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/types/interfaces/KubernetesListObject",label:"KubernetesListObject"},{type:"doc",id:"sdk/types/interfaces/KubernetesObject",label:"KubernetesObject"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/types/type-aliases/IntOrString",label:"IntOrString"}]}],link:{type:"doc",id:"sdk/types/index"}},{type:"category",label:"watch",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/watch/classes/Watch",label:"Watch"}]}],link:{type:"doc",id:"sdk/watch/index"}},{type:"category",label:"yaml",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/yaml/functions/dumpYaml",label:"dumpYaml"},{type:"doc",id:"sdk/yaml/functions/loadAllYaml",label:"loadAllYaml"},{type:"doc",id:"sdk/yaml/functions/loadYaml",label:"loadYaml"}]}],link:{type:"doc",id:"sdk/yaml/index"}}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/website/docs/sdk/types/classes/V1MicroTime.md b/website/docs/sdk/types/classes/V1MicroTime.md new file mode 100644 index 00000000000..90f2d773310 --- /dev/null +++ b/website/docs/sdk/types/classes/V1MicroTime.md @@ -0,0 +1,141 @@ +# Class: V1MicroTime + +Defined in: [src/types.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L18) + +## Extends + +- `Date` + +## Constructors + +### Constructor + +> **new V1MicroTime**(): `V1MicroTime` + +Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:926 + +#### Returns + +`V1MicroTime` + +#### Inherited from + +`Date.constructor` + +### Constructor + +> **new V1MicroTime**(`value`): `V1MicroTime` + +Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:927 + +#### Parameters + +##### value + +`string` \| `number` + +#### Returns + +`V1MicroTime` + +#### Inherited from + +`Date.constructor` + +### Constructor + +> **new V1MicroTime**(`year`, `monthIndex`, `date?`, `hours?`, `minutes?`, `seconds?`, `ms?`): `V1MicroTime` + +Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:938 + +Creates a new Date. + +#### Parameters + +##### year + +`number` + +The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year. + +##### monthIndex + +`number` + +The month as a number between 0 and 11 (January to December). + +##### date? + +`number` + +The date as a number between 1 and 31. + +##### hours? + +`number` + +Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour. + +##### minutes? + +`number` + +Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes. + +##### seconds? + +`number` + +Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds. + +##### ms? + +`number` + +A number from 0 to 999 that specifies the milliseconds. + +#### Returns + +`V1MicroTime` + +#### Inherited from + +`Date.constructor` + +### Constructor + +> **new V1MicroTime**(`value`): `V1MicroTime` + +Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:926 + +#### Parameters + +##### value + +`string` \| `number` \| `Date` + +#### Returns + +`V1MicroTime` + +#### Inherited from + +`Date.constructor` + +## Methods + +### toISOString() + +> **toISOString**(): `string` + +Defined in: [src/types.ts:19](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L19) + +Returns a date as a string value in ISO format. + +#### Returns + +`string` + +#### Overrides + +`Date.toISOString` diff --git a/website/docs/sdk/types/index.md b/website/docs/sdk/types/index.md new file mode 100644 index 00000000000..cdc701721b3 --- /dev/null +++ b/website/docs/sdk/types/index.md @@ -0,0 +1,14 @@ +# types + +## Classes + +- [V1MicroTime](classes/V1MicroTime.md) + +## Interfaces + +- [KubernetesListObject](interfaces/KubernetesListObject.md) +- [KubernetesObject](interfaces/KubernetesObject.md) + +## Type Aliases + +- [IntOrString](type-aliases/IntOrString.md) diff --git a/website/docs/sdk/types/interfaces/KubernetesListObject.md b/website/docs/sdk/types/interfaces/KubernetesListObject.md new file mode 100644 index 00000000000..d195cace2af --- /dev/null +++ b/website/docs/sdk/types/interfaces/KubernetesListObject.md @@ -0,0 +1,41 @@ +# Interface: KubernetesListObject\ + +Defined in: [src/types.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L9) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](KubernetesObject.md) + +## Properties + +### apiVersion? + +> `optional` **apiVersion?**: `string` + +Defined in: [src/types.ts:10](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L10) + +*** + +### items + +> **items**: `T`[] + +Defined in: [src/types.ts:13](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L13) + +*** + +### kind? + +> `optional` **kind?**: `string` + +Defined in: [src/types.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L11) + +*** + +### metadata? + +> `optional` **metadata?**: `V1ListMeta` + +Defined in: [src/types.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L12) diff --git a/website/docs/sdk/types/interfaces/KubernetesObject.md b/website/docs/sdk/types/interfaces/KubernetesObject.md new file mode 100644 index 00000000000..fffe5e5fac2 --- /dev/null +++ b/website/docs/sdk/types/interfaces/KubernetesObject.md @@ -0,0 +1,27 @@ +# Interface: KubernetesObject + +Defined in: [src/types.ts:3](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L3) + +## Properties + +### apiVersion? + +> `optional` **apiVersion?**: `string` + +Defined in: [src/types.ts:4](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L4) + +*** + +### kind? + +> `optional` **kind?**: `string` + +Defined in: [src/types.ts:5](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L5) + +*** + +### metadata? + +> `optional` **metadata?**: `V1ObjectMeta` + +Defined in: [src/types.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L6) diff --git a/website/docs/sdk/types/type-aliases/IntOrString.md b/website/docs/sdk/types/type-aliases/IntOrString.md new file mode 100644 index 00000000000..3abe61135a7 --- /dev/null +++ b/website/docs/sdk/types/type-aliases/IntOrString.md @@ -0,0 +1,5 @@ +# Type Alias: IntOrString + +> **IntOrString** = `number` \| `string` + +Defined in: [src/types.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L16) diff --git a/website/docs/sdk/watch/classes/Watch.md b/website/docs/sdk/watch/classes/Watch.md new file mode 100644 index 00000000000..802f4d068ee --- /dev/null +++ b/website/docs/sdk/watch/classes/Watch.md @@ -0,0 +1,67 @@ +# Class: Watch + +Defined in: [src/watch.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L6) + +## Constructors + +### Constructor + +> **new Watch**(`config`): `Watch` + +Defined in: [src/watch.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L11) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +#### Returns + +`Watch` + +## Properties + +### config + +> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) + +Defined in: [src/watch.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L8) + +*** + +### SERVER\_SIDE\_CLOSE + +> `static` **SERVER\_SIDE\_CLOSE**: `object` + +Defined in: [src/watch.ts:7](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L7) + +## Methods + +### watch() + +> **watch**(`path`, `queryParams`, `callback`, `done`): `Promise`\<`AbortController`\> + +Defined in: [src/watch.ts:21](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L21) + +#### Parameters + +##### path + +`string` + +##### queryParams + +`Record`\<`string`, `string` \| `number` \| `boolean` \| `undefined`\> + +##### callback + +(`phase`, `apiObj`, `watchObj?`) => `void` + +##### done + +(`err`) => `void` + +#### Returns + +`Promise`\<`AbortController`\> diff --git a/website/docs/sdk/watch/index.md b/website/docs/sdk/watch/index.md new file mode 100644 index 00000000000..6c5ddb17669 --- /dev/null +++ b/website/docs/sdk/watch/index.md @@ -0,0 +1,5 @@ +# watch + +## Classes + +- [Watch](classes/Watch.md) diff --git a/website/docs/sdk/yaml/functions/dumpYaml.md b/website/docs/sdk/yaml/functions/dumpYaml.md new file mode 100644 index 00000000000..840366e5bea --- /dev/null +++ b/website/docs/sdk/yaml/functions/dumpYaml.md @@ -0,0 +1,27 @@ +# Function: dumpYaml() + +> **dumpYaml**(`object`, `opts?`): `string` + +Defined in: [src/yaml.ts:43](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/yaml.ts#L43) + +Dump a Kubernetes object to YAML. + +## Parameters + +### object + +`any` + +The Kubernetes object to dump. + +### opts? + +`any` + +Optional YAML dump options. + +## Returns + +`string` + +The YAML string representation of the serialized Kubernetes object. diff --git a/website/docs/sdk/yaml/functions/loadAllYaml.md b/website/docs/sdk/yaml/functions/loadAllYaml.md new file mode 100644 index 00000000000..cf273aecedf --- /dev/null +++ b/website/docs/sdk/yaml/functions/loadAllYaml.md @@ -0,0 +1,27 @@ +# Function: loadAllYaml() + +> **loadAllYaml**(`data`, `opts?`): `any`[] + +Defined in: [src/yaml.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/yaml.ts#L28) + +Load all Kubernetes objects from YAML. + +## Parameters + +### data + +`string` + +The YAML string to load. + +### opts? + +`any` + +Optional YAML load options. + +## Returns + +`any`[] + +An array of deserialized Kubernetes objects. diff --git a/website/docs/sdk/yaml/functions/loadYaml.md b/website/docs/sdk/yaml/functions/loadYaml.md new file mode 100644 index 00000000000..eb1533d24b9 --- /dev/null +++ b/website/docs/sdk/yaml/functions/loadYaml.md @@ -0,0 +1,33 @@ +# Function: loadYaml() + +> **loadYaml**\<`T`\>(`data`, `opts?`): `T` + +Defined in: [src/yaml.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/yaml.ts#L12) + +Load a Kubernetes object from YAML. + +## Type Parameters + +### T + +`T` + +## Parameters + +### data + +`string` + +The YAML string to load. + +### opts? + +`any` + +Optional YAML load options. + +## Returns + +`T` + +The deserialized Kubernetes object. diff --git a/website/docs/sdk/yaml/index.md b/website/docs/sdk/yaml/index.md new file mode 100644 index 00000000000..016ec239289 --- /dev/null +++ b/website/docs/sdk/yaml/index.md @@ -0,0 +1,7 @@ +# yaml + +## Functions + +- [dumpYaml](functions/dumpYaml.md) +- [loadAllYaml](functions/loadAllYaml.md) +- [loadYaml](functions/loadYaml.md) diff --git a/website/docs/tutorial-basics/_category_.json b/website/docs/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55b1eb..00000000000 --- a/website/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/website/docs/tutorial-basics/congratulations.md b/website/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a00b72..00000000000 --- a/website/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/website/docs/tutorial-basics/create-a-blog-post.md b/website/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index 550ae17ee1a..00000000000 --- a/website/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much as you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/website/docs/tutorial-basics/create-a-document.md b/website/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index c22fe294468..00000000000 --- a/website/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/website/docs/tutorial-basics/create-a-page.md b/website/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac30055..00000000000 --- a/website/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/website/docs/tutorial-basics/deploy-your-site.md b/website/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee063ef..00000000000 --- a/website/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/website/docs/tutorial-basics/markdown-features.mdx b/website/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 35e00825ed7..00000000000 --- a/website/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md -![Docusaurus logo](./img/docusaurus.png) -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - -````md -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` -```` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - -```md -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: -``` - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/website/docs/tutorial-extras/_category_.json b/website/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc19300..00000000000 --- a/website/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/website/docs/tutorial-extras/img/docsVersionDropdown.png b/website/docs/tutorial-extras/img/docsVersionDropdown.png deleted file mode 100644 index 97e4164618b5f8beda34cfa699720aba0ad2e342..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 25427 zcmXte1yoes_ckHYAgy#tNK1DKBBcTn3PU5^T}n!qfaD-4ozfv4LwDEEJq$50_3{4x z>pN@insx5o``P<>PR`sD{a#y*n1Gf50|SFt{jJJJ3=B;7$BQ2i`|(aulU?)U*ArVs zEkz8BxRInHAp)8nI>5=Qj|{SgKRHpY8Ry*F2n1^VBGL?Y2BGzx`!tfBuaC=?of zbp?T3T_F&N$J!O-3J!-uAdp9^hx>=e$CsB7C=`18SZ;0}9^jW37uVO<=jZ2lcXu$@ zJsO3CUO~?u%jxN3Xeb0~W^VNu>-zc%jYJ_3NaW)Og*rVsy}P|ZAyHRQ=>7dY5`lPt zBOb#d9uO!r^6>ERF~*}E?CuV73AuO-adQoSc(}f~eKdXqKq64r*Ec7}r}qyJ7w4C& zYnwMWH~06jqoX6}6$F7oAQAA>v$K`84HOb_2fMqxfLvZ)Jm!ypKhlC99vsjyFhih^ zw5~26sa{^4o}S)ZUq8CfFD$QZY~RD-k7(-~+Y5^;Xe9d4YHDVFW_Dp}dhY!E;t~Sc z-`_twJHLiPPmYftdEeaJot~XuLN5Ok;SP3xcYk(%{;1g9?cL4o&HBdH!NCE4sP5eS z5)5{?w7d>Sz@gXBqvPX;d)V3e*~!Vt`NbpN`QF~%>G8?k?d{p=+05MH^2++^>gL7y z`OWR^!qO_h+;V4U=ltx9H&l0NdF}M{WO-%d{NfymLh?uGFRreeSy+L=;K`|3Bnl0M zUM>D-bGEXv<>loyv#@k=dAYW}1%W`P<`!PiGcK&G-`-w7>aw=6xwN*)z{qlNbg;3t z^O)Pi!#xywEfk@@yuK+QDEwCaUH{;SoPy%*&Fy2_>@T??kjrXND+-B>Ysz{4{Q2bO zytdB!)SqeR7Z*b#V`wz;Q9sbwBsm#*a%;Z0xa6Pm3dtYF3Ne7}oV>>#H$FLyfFpTc z@fjI^X>4kV`VsTHpy&bqaD992>*x36$&m_u8MOgAKnr zix1C^4Kv*>^8IV-8_jZkZSn%yscddBFqkpaRTTAnS5A$!9KdgBseck^JSIQS`wRWHIZ&85f`i++% z68t8XiOy$@M67#u+Xi6bxpuq+`HWa<2?N@OcnUhX?Fa0ucuMgFJFc-@1+=(NlQ>>F zRDxG-|GOh}P`zp=#(X0xY7b!pCjittaWhLjHXBB#-Po`?sO81ZebXXp;sg3B6U;yT z7ltQRr)1+s9JQ^V!592xtqynFYr$yy)8J4=_Fovpb*N%#EBk3~TNxng@wp@YN7Lqp zrjUU+o-9X*B{;#FfWF+8xsS-jI`K=*Kw`Xfb@RSO_U)QsNHa<|mWk9yQ?OwtR*_xq zmD=jg&|q#_bdPo=j-*xO@t@Lx#ApL+J`iqWlGkq6;4fv@4RCK_O9tc(xtrrh=-c5R z69GA#i8S&gK?|;>DM8&0G0qF?C*`-kOcVP3)1oi%f47pC4CS=HBdpf`E)$Hno3D*LM*Mxsl@|fX(Xf%aXWP!}X9^S#Vk`h=79=r%L^l^YWXw_fRl+4teQ3x9_*k%}TKmP12k&)U zMNC;?1$T%`tp^#EZUUbydm4SOs@A)}3PP>tiL3j_W06pb3vSHu)DJU-0m)ledRGV0 zJ|rcZ1U@_hCyPE6_-wiimvjR3t);y*Qdi`BKX*PP29RBAsD8W-^u0fLrRq zwCLWC=t#&Nb(JimFikS-+jq}=-klKJuPf|#4pY8f?a%e6U2$1>GPfs~QJLAlns4;O zgz6*qdCCdKNu92Gtjo^ob%T4S7Qi-4NMGg1!+m0yH08I3TITyT6-g}m=2u_lckZ^e zq;^$v+pjrNbh#BOPdii=sJ1bq8F?sZTJcTI5o-P0V#bJPYY`?awnv-41^CJh$BpLP z@aNtrc;&0^lO>O1M4Is=8YA9!yo9_AI^mA7`Aw!579-QByLL>P$1D=@r}QPn38D;% zpBWvkXSRS?b^4Pq$yjf%7Lcq#0#b>rLc!^-G|4-BD83fHp~~6CQ_U~u{@(n0go&P^ zDHT6>h=0KJ)xPF^Wh5@tUEbM@gb&7vU*9YcX;|;ESv3bj^6HmWbTMt;Zj&y(k;?)$ z!J2pIQeCULGqRb5%F}d?EV$v(x+Zqs7+Bj<=5FIW5H^? z1(+h@*b0z+BK^~jWy5DgMK&%&%93L?Zf|KQ%UaTMX@IwfuOw_Jnn?~71naulqtvrM zCrF)bGcGsZVHx6K%gUR%o`btyOIb@);w*? z0002^Q&|A-)1GGX(5lYp#|Rrzxbtv$Z=Yht;8I!nB~-^7QUe4_dcuTfjZzN&*WCjy z{r9Sr^dv=I%5Td#cFz>iZ_RSAK?IMTz<%#W)!YSnmft3Nlq~(I`{`Uk-Wm83Cik$W zA>ZEh#UqV*jtmtV`p(`VsJb>H>??z9lR#V(`9^UEGvTix4$!-_w1?L1)oZ^W!E0k* zCB7_q(G~1Q3x6mPdH1`hse+Jq;+?Cw?F&D*LQhHFoFJdd@$J@~sOg%)cymn7a4znI zCjvkBKBOSb2*i~|Qom$yT*r{rc!0nX+M`4zPT|h~`eXtS!4FPTH0(?%$=fr9Tr*nb z(TR6>{L$7k2WHlqIT4J->W-mYgM)ac(R(z56AY2Kiex&W>I$p+&x#bMNS&|p@eWOy zGD7es5=6U#uG^J26B@SERc=i`I+l4_*`E_OxW=&=4|rH=p;$GB!%As!i|~ypyq`M{ zX5L!TI*|QR-pt7Y$irT5b=w9KcWKG5oX;$>v|GNckJ5XfdZ#KHirMyigcqZ9UvabrO{ z8rDp1z0Fr%{{|@&ZFm^_46S#?HL)}=bp45eUvA1gf(mODfe+cGcF$6-ZaI;NvMu;v zcbHrkC+lE z7RwO#m?)*hw^|}s-z?wPDEMJ2%Ne3)j0Dnt?e(@i?bf<+s^BM?g^S5YKU~rg%aeTl zJf0#GyUY|~Y;9SV_?#uV9<{xsFjl^YeW{@1$61GkUgc9Xv6cL@uB^M?d@o7H zHKV^XV(Q|Q%Geas3dw$Jn&atPqxYB>>Ii<#Zv+@N8GYs#vrxfbS_%zJ#18<+55b3yBCV#A}|5J8EAtdUd zn{=~8r&YaM_GB^l@6D_xfSvmbrbJP^&RZ{np(I^~Osf9d>=xz;@EnY?(Egg`%_&Vt zJA2@>$gsV@XFKh@>0z#d4B>B{^W%bCgT;)f6R|f%yK=!bN2w`BOC_5VHz(Q+!7ID^ zl#oQ>nDe2!w&7tLJ8#8wzN%$7@_>{Hh2xdID<0$kb*>G$17$S3grFXLJQ>4!n!>-B zn>~N~Ri%vU@ccS?y8BTR)1#fe2q zlqzp;&z9I1lrZ*4NJn00*0|iPY)Z0d$3NTJ9HNQ+?JI;37?VSbqMkdoqyCsG=yp1B z-3WO8>t^=Fj^?PT?(-0dZ8y_FL2Z9`D!m-7Dgr7r>V~Rm8RQ@w>_PrbFo$N_#jGzx zKC&6u^^M`8cdv1&AJ-O}jSqCR94J?FnYw!JN3(k7cejfuS`7-j*t4GNaKH@|kkrB_uY?<%tF27r;kVj(nzxph1JsFr z#*%R0;+(NAevpx|F8|sz9}SI%^z@E#+KR{}h1fyNXo6z$e*+nNx|qKR4DoCl0?&Q@ zs8_MHOw&gA$VQz4yIo@Zg{!M@m9v_4{_V!x@I>5ZaG$rcOvUm9O0DW9tR>#oyg@l8O!7%+a(wcN zU}SdcI3?TjNeNXmMJ!GUx@tFbszrKU5?ewMLA zJ)^SSUMDXb)yO8<*A&?2bBN&NEk{+9q~*w%k^+OUs)b@Fs#!)#9E-|}*u zWAn}H61Uy!41$}d1d44D;guxTx^kD367XWM%5Dea)6$5&n;))D;D^r~G=m$CqS7L! zmLX|kejC<`PU-rS#;n2Y0*4;&?(ROps&9eVSDoY%G@-4kyG5AX|Fu&1M5Gm0(-Z6v%1@fS9$`LGCB zlH8i;1e!(dUd#1c@G(-^QedB)$yJ~Yke{h3 z$#|*Md8c7)??v!utM3QJT7mN@DE%_r@BYhvf))3qME|n>shVP(03fO0{Iye<3)wv9 zoYDZ$wDak&n*QW`-s6KKDk5X1OQ_ramOCv4gjh1}jy%9GX!s!hq`NW)&%o9y+YrmT z+u!YGVhHBA*{|c;^}Xg)elpF+dMcpHNALqheHQIX<8J#~;Ah^+Dw~L#CynKWfTWCu zCEbY3ybkQ225nUxd$i6(3SN^?}z{r>!_8$YiwX~LE`rzuT=q!8;h{UbMWDGL@VpWm; zZtr3$23sHj`&Co0No!R|5#Vt7{9}j|TwplkHdT=aUeQ*;9XQ2uW1WUTbA%kHwMR|UUq0xTEetKps9KmNYAS5aY+L31z8w-k=r7r5hSK=6A!^nU z8C>n~S?X}?D5`5c5&2wA0cxo;KgFAi4N2T%LF4fWoMQ=CTo>=1mjvBvW;|iPUB>xW z?K5>~6VIpJYo28I)EFl&7dAhqrB6A-(e-)leVf;X*$GA~eVokc6j+rvRq{{fZth{*dW0`N_!2w6Ll9fV z{aJuKFd-zavy0~QH9hD;H%Q(_Zn7nY>AkaeKuL7Q@G02wArkDPH53Qg5JGaH{_ehi z35yHf_=pB1wY&Ak3EZ-^Ml}MxJh6d_Z}jDN7RTDy68ton&H$4=>#b4w904+;t6CcZ zMtV{hLGR06a?g$sZA#7RlKPF4Bqk=}`#oc=#~O;oUX7hbb^NY3f2Nin?(&;E?zVkm zN}OTyV%mP6T5(MT-syZn(K?c9sk)z$K0AQvvk9#%4%)evu)aOXbB;x-*G5ljx|A;$ zZmCV}y(IS$SYPVS%g#3~I9lE#erA)7BgOkZC}~2)7B_BBStEVtr1+0nv{(A%zhmjT zsE;^zwY5(ZCyf%wwr*SJyK_?Gv_p!Oc-8$W?a03T_8q zb=XB6)**gF9AoG(=dN9-4yO7)FI}g2!0UFua`5ASTp*W2K#(fpZHPv2}6 zuI3YRPb*T9uhpKUc zPNT}NbGpABC}F~2UYA?vuN z*c2)mWKvZn<+PL%-Oq3lAhrw_j}+<$Tfvgoo)dRh((_MP7Iz=PwI|1>aObW5-b8qW zI@O0@c{EbVHN5a6k}i4y2?Jh~=Jd-MZnv)h^T1;2CAllrl%EHm`1{XUiW<7g+6{XS z&hVyh5*+TiVaO)+4PE3HcnsJajGx>gwo1EcWg^*Rn0l!#MVM%(Ywui_UjM8Dgspk@ z4`gne14lZ*`698%UOOx^(v_~kQiYj`WkY>(f5KDC5I{-Wi!KoINK)H^9m|SUliD=d zE;N>?`0x*{61(==UBrN}mpsdhOZ2N~I>oQ1avz|nvyfQQW_R6VAnn;IzqlxDB)0_Zw_Csf#5sdmb4LBwIyBk zv$NL*@acUJc4`FtA^-PzoHR zKXm{;9xP9kWW6MEPYuCeDqX@UiY(8GShF|L{-)R4_acdmp+&W~4nBxde z;pI70##wwE$hfIrpx@VQ`Yc>|xSP$S8~WoVKTg5Z*KMWE)Yp>$m>ZoNQ(u!z-#`mL z1jJZHKZ}Tc5Ap^(*KIg6ol~wx)s~So91kdWaF2c{?F58%EDiT9uV&xYWvS{aFS{hE zg--eu{(>bL!0h)=md^{aR(APus_Mr}+}|%Rb(>B&dHn3fw9>d3rkDH6x0-@)^Dkwj zjb75;-8>7gmW&$y_4x~rPX!&!>l3d<-kfo+g{PIl%s;UQ)Y+u z4&z}r;Sd{hco!{2a3}F*4CAcydj7`#V0_iRg%G&NxtQpm=(5VbGfiRW^NoBJ1rPE# zzYktZRk7>`{fdU((V`a+T{&n=cnr4LaS!S|hDOtXWb>_e-LwH+@FmdGw>6+B9J6~} zcBaNb(<-c6&|ghc-%o3xG(Op-q&pXd1CfV zgPNdKX~vGy-LS;4Q=161sLAoMaXGG7weBcT%KmWHZ${+6bC6yehCjqK36LdH>fR!{ z>Xe}eUaWsRp8U1&?E`K@0*oHDY-p{^+u0T&$b)J}|G6C(lSRuN&WgUd(rH=0h9hUz zj|U@1UmNWdbn)SLk^KR_nRxbB`hNKP>?@ocdEL;;1l||Q0{~Zx5N5FT_ z8{|xM9~@McIdv|?#WPK>1b&f`?=bvMO>?(;W^}|VZ|%*&C_rsnS5&E~%`>$1I#;~* zn=Wx?omuI3X^Q4D$;n_~HEv`6`Rwl7C)iTwB5O~BB+$PgQTGE~V(6h;78q+*a8tK* zi)1P_7BY;9ea2|o@l#u>z4b#X%;a|nTq^l*V({7P;k z=t-%I--DL{uv#dVtaWg|q`lNci7#N7sC(@vBesWbHEY@Gb4`DozcU20N<=vl;-%s5 z!WzFm74mydG1Hjwdk!c_6!|q+Noz5>DrCZ!jSQ+Yjti$3pBqeRl}Wv|eimpd!GOY~ zDw@@tGZHFbmVLNc^ilgjPQ1os7*AOkb2*LRb{O-+C97i_n z2I@>^O)#WwMhxr4s;^U&se%2V#g)$UMXcXHU)C<7ih`meC7t?9h6U9|gRL%vjBW=4 zyJ(KaCRlNg`fO6a(x7h==WMvQG|_Skr4D&0<8t`N`#*Y0lJn{f4xjR5Q%h*qiJ!9l z{{3xuZ%nm38N+XqLO_y}X{{=Z1sg+iy?Wk0(xmzIV8KVwj}M}&csjjc2tOdzyInRf zj&mB~+`^C>=hnyxW|Ah^U8Pcl0}jx|K^QWjuTpX%S?_Y({asp@tk2!qmNiJscA|3v`}jyo*ALZ(Rr*ar91T`}p~N<62j4RJ|PDBQI3t8Cdh) z?R$X25f31}sp@&0jG5+in zs$WmohuauhuK4uZ1iNJsy2T@EuDDT=`&$LT=jKS^o}44OK5cA$zAzZq&gS)a(=xC7 zC(q}(#ncl6@1^p;YG?lVnJ)t^7Ky53%ZtMKP6FKlx|zSaeDQD~}Xbf@cZU>-AI+P+4hN52dWFDA$qg=0!5}U9qLoblC z?2V$GDKb=Lv@me&d%DST)ouSOrEAoGtLxcGg1~Kmzbq?}YUf=NjR9D?F9<}N_ZiNa zZhdC>2_z-iy!(9g9{n11i3|~!hxmAYX6z9olmC=&YcsiKI;&XK#&iSd&6&{u1@Hd^ z&}sU>_G+y}Gi-8`-k*Exr{a$>MNGj_u%u$;s_fOjknwYR-qt1G|mi}nQ%CB|0Vp`=0tc2y(3 zJ}XmzSQQ~(SfJW-|mT1TaDmxNCml#nWVyhIvX z5(>8xARd*joOU-U;Dfj+E+nUJC25bpe>!0L^f@BXZEW73UVfjT$=FTfw8u@h@$hDQ zVua*ub@?Dlc%%H2Kt+bYLb>$(@roZ+vrM&so0RO(eTY12?=Hk4*qI39-0yU@%aQU) zh(=Pxi6yISqhKQ$i^SEeyiioo-1GNY25sM+qoj*Y3&qp^8_)87sMwbecGG~;>|9TP zREo(Axioj6Z+vp*b2~Yp&YghcPwB1H+J6C`1#2tPkLCkZ%eJSah9>34C6}Wx52PW# z^-a1fn~bY&PC$SE9!mvprG5JAMZ8#PQ1utYB%g4fm*YwmC=|j!Ynky<|7ZL;!BWr3 zFawY3dr};&T$Ip3YmV+)De<*8`l~v0VwiNIPNf3|&X$o&6@|n6LRM@CjYQR1 zWBH=K@#i3!;27}0=N!39tP9ZWSn8M>14nC%WHmBMuFJAk%Lb z3uC1S9h$5}_+BVizP47z7mQl9&0QY+JB+^dI{s zw`OaYK6by8i7`3&)Phx%c((j7B1YUWiF2MMqu4sv*rJ!i;BLj(fq}XbxPz*4fPY?O z@*Ky#cmpT^|NpZ9uUqz`68dgR9jtzXj=}e&QRIn}pQRT9PLxt|PUrc*i*0b!XrG!5 zn0}>27K&TEtQcrzD<@JD6Z~^YE+@bp^w7O54P0!hf0Y2>E)Q-^2GDnxCg+6##J=z7 z@ngMS&`rDgl6d+JcSuka%Z?(3I;F~=S0|1#j5>jeKEQlh=sBqfv!hBN|;yTWLomu=my`^LYikzJ(>0epsIY)kU18UXtB-3pcSlnHT_D|^@nAOvSZ&U8G z2j{}BU*x=`J<)n1d{C?*L9G7(UY zOa>7`PWnsf0_A36hyo=b^S{8-brz>TuX+X?u5rOaa-i+Qwt#GO{msTqNOcGW+e>Es zB9jlrN(d>)QU5{6)p@F-7=X4^mJ_o0PmD`XJxKX3yEPtUxGs`3c=nmm=R})T1N{pn z-4`5~hgSH{OLb&X7JJ{Kc!m~cw^Px|bf;E_^&_m2-RyF$>hpwb^&OK2x<&5mZY$DQ zM*Ba9X2yg~f2CrRi%7#Gmj8ToW&RX3woB;vaQS~RStNrN_ip=L(D5O`5ARa1*tbl$ zz*z9~cch#eZ(SfXecVU8>@a)YoW^a+0f3~j0Y?^-$NJeZx)){fSvT?~Oz zr|rs5)}M)5nL!oe|LIs_Tje3%Izv_8s~up;gZHa$tJ2apK4+*%@ezaqN}(Z)Knf?w z50}vMb<0<55q_7mTNOQDi&W|)caK!E^KS2+JE#Q+@^xmQv>inXC5o`mvE&$TOke$B zV8GSwhlTR2rzJ#_;)bk${WP%Ih)i=EYN8{o&z8%2I_q?VymrtR;v$zLkjrg{wpYbS zvAcy#5)@jAvZp4FuHHU2=>%7yAaF;Pr;R4Fs{JD~J3=fZ1&XUJg-%A~!KmHC3n)>YIEi}NEb z%--g1St?_*DOh+gnZHtmEkxs@isI}eRrc0wU8l;2b@mCiAM#Nn997Q+LV*)|qbtKQkb_f0o-p5pdd)@GMF*DshM3Aa+3F#`qRIwJ0hm)o|YEL#OaBEakx*CoYj z!aPt=uH3>5{Lo)X0vnhRQ)s3fJD8{|J(JOpEw+)Rk z`bt&Qmfn=@fB#v0H(jRr&%qMgqOh#^u@wR@511#rdFm|rRDW^uR0I;SFNFONvL|T< zNgTUA$F0a)aQgw8fuB6MGPB@qT?~BCYk5+Jsf=?}Mb;HKNTkLenT0K8t8|H}D?|hE zSgX!{rJBv{`q@9kgrWLKN$Lc=(eX|?lLDj zTIgDs2{@)$i(H$~)t&t0ljddg!CF6;h;#+vfsiOq1m6z-@3HjZf9Cwjssl8*? z-Zk;h*SQd?Jne_EnSeuFHFb<4o#^De>LcvXXN-SWl?t8{*wYg3myaD#!ASmyRX(M* zGTP9W!pDwsi#ZmX__)rLPoItw3NlJ2we~Weclgdr7?3%+JE=SOCt;iGP}}vJ5Q|LG zVyV6tvP?5JtW=tF&6vZPw&HPWnzz1x|7JWQiR85>W`0|GOLyooBAJSsXr;fTClQ*2 zaK)sev-vb*PP9gBV5`_Qo%^@(nz4=7wneRMzW!+lzgV`U{S>?Un=WkYC)GrP*^Co~ z39gtoderj4l0kRRPB`Ahk_XC*5YRAEO&?q0Mzru!IeuE^lBSp;^j8_6-!y50K|n_p zGMdRWFh-Fi>Ry&?gYb(4RdA{FOqob;0q^4FiX*<}mB;zWot5?G&X7RqtC)_A4|jTu z$#`}>b~R$z#yqsMjRktG(!I2WS~hnaPgt1B%D#`8tL9}l{0BaIb*@{Pzt#{=K}Oe* zDAsQ#vX=-a{P_Eyl10+;FIVppTs>K45GY321_I8QO(l>aZ1$65njm1IL>Tmd^bv>K zqvaOE2UgLp-Yu%rF$JfIMhMuRr(^h3Hp`{LBoH54u5@YGjy6Wg?Q*O?XEIX6kMCO~ z<_kZcb1u98AU{a8r7g=xIgs_PH3)hJ5I+6utGV-%RP@*Qi)z02$Wuo9%2dn$3FhdS z;i52o@P_mdzh~c5s^ah~8Ps7Wp+76`e#%y5agtQuPd3{4@zh;+PJ;Ul(o51qE_WV^ zg+~a_eJ|*Xi=4jabrA&e^&&@I6=VSbgQoPeA2W5wnF#LY-O>}Ljj#`MCRMaV%vO{76cz-Og(S_6~uR>qnR(*x+nLISCR#;o3%W_6?D!w;_CpEp6{@(I+A~0_7 zs}lPdr=NoC&$L2h;r!KHMBq)8eU7#yV&?{?? z=4x^BMDRXs3k2G`S|TGIzZ0Hg;o-%T^9GFBO*20Lb>W?krt$`*_Y)pIqLTXjE~di< ziI$JBW{M?JgMOp7XK0RqD!` zyjnzWp^?d+&R3;V!S}YBsE3^$ov%4ipg*$x>0&cLpey(^IE*D!A^->G&P+M7+J2(; zwd>Ep{Zo-~HYh#S%R%s38W8{Ca=WoD??Y3{$m(9%xV*`*LEmoP1$uIW>TgrB$+onv z_ndvbMOIqVFhw~TrM%u2A6A4v!m5V5;SK21dr|_++u|ReV)&#sK6$=&(H*ZZXM7U< z=e@Z}9GCKoq)cAQ9euu8+|}amPkIa3BNZHT6d18a1P&$d5_02Ht2I0xoGDxi-;5;j0tI=XFRNl62_x%#|RTOCW zg*`>@ux)y<;|r##9cIl^Q&4#~Z3CkHHz`X=;xCJy_@caXbk+{w{=u4_bgn+6>EKRa z8dA{~?4*L&vu;0?5LGS{cbn;+@q!-7usGB$?e_1K0#gE|Ot9ixD#X(4>uu)f#}~A3 z3@nGY`HD_hpAqWw8U%*?yVSuzvJm;5G+nq@Cd+=}W!n*06lvdQCuXal{9Xs<5I5oC zcw%nh=Wg?~Ugk@T1@^y}Np7w%vxB-A9tdKDt{<)FX^ubm$7SZacAr-%L-a1JwG)#C1c0gU_I^Cd_qciW@*(2ezbRpD6!<$ zQ+C*RGs|w;)ZO`^revsDl);H7f(3E%K@i2Y%eE!3cq&}mnmjtQ*Z=hEWe2W_A^XH?Nys^bJZp5h>K5an>5p6yjNY zREWvikLx;$(K_`V*R=<8<|J@62`31~=7iCV$p6c%Lg1YAc$h-uj ziA#pcUoF0HIj*$$+!IpLE!H*6%e?c8aHZ~W{8>f@QlFmqcJUBtER_3}jheE>hx}mv zf%%k^5;hsmrzrQC;sDn(d(nBjd1K!gR*&*-DQ4;zv;)vaatjg36nGZ?Rq_l;c6lQA zQhH0eWpKygvHd1%l_?G78|(|eJ53Tsg#N4Hvjo0QDebJQL;DKH#&_8b>p%_AdE^@3 zLP(ASqIYgP6n3POQ=*_HPw&ScHtu&nQK-?0+ z8>8|df?xb$oR$yQ8MoZfbQyr0elR$(MT?`-AAlb&Ga4F{{$^zoyi|S#Y2?CZrv_8g zaK5GIo1kiS5{V~y@0UpiT9TI|Vx*t!eaK9kRthIgdFvr#q?-1&t(a;pT=yrB*xZmb zYw8R5P*fjZoZoV$hSYocS7&0+G_-lb)kFC+Q>p$|lmq`}9KRe3H$HuG_y|Xz*Ykic zBp$CVTqZL0olc9!_rqG86IPu{8Iq!Y?GKoMknsM|jFN<nmkWW$R)0;=-v0xAm_otSVoWlb^RlPVJ7p1U|d^4=E>-zP*-Rmrv6} ze|&GPS7f_&uWb1R`Q&)TSwU~0v1a<`-)o6LgtM9rGA0LiJ@Ue`$XcxSFf)nQC^6NuI4*n18HDDl~3>VPbX+k7zOT>bP zjw?xBP7GAvQDt>BQx!=@sw8)=gBtaH=3ce`T>Xns6feL{J+BW8)Q#=W-7NmHaV*F~ z>UmFhh7MkTGy+xsl^XpR;qG_do8Awha7b-nS4*taqw15O=A{`zjy!fUT4*O~Px9G* z&%KU#?o;#N;>89$=?gplzj3XFNdj^3RMIHRL=~;oyK7Quk=^>0g#CAZ(QGGeUGLU* zWPaROHN4T{eRhQdB8Y!9jcDKvnUVfi)uLU;QxRVsz{0S7@3sEf+Q?Ls|HWY4W83@} zlSXj&#g|UeKk!d^F8}ntYOtDT?R^m4cwFr4JG~o|z8Zm1yM5aW({Yy@f~BU11L!v#Td7eeD4W$>lcjaG!42YE?~f3MI=4r% zoOf_vBji`oQ?lj_PxRf%pt#H=+;A1r#K4^1?Htf{euOeDW4^2m#LA%gz+PfcvYKB@ z{l5(10Q&Plb>;K9_`Jn-xRvcD^qdB-b$9yeMaHX`lv9~f(0}6fFn#1NHFDl)U4XX~ zltY}5+&}s?L_h~eET8)X6I%nfweCW?o!6vD{DiG}w?pr%+YfFCFf-a6yId6Ra|pe; zDl_g&Cv!gUMl0Z_t9nh5KE)coN>{ zg&1(j`%gkFBL`Uj=dI12!|rM*w?!U{waw}fJ_H(zB}-9=p|eJ;sfV<_S)YhAe7eDS z{-N^pB#iLATr#NLu{RO!>S;pwW=9=;trCin9igtoOlB&izD{7ASKh z(CzzkugUVut^bL;3>2f~%R9WEhM%m4uk8P(3g_CM>~SJy%}G!J2{hm1T1XXM;$Nx< zvJ>kKg7*&8803!xLR5KkS8}@!TpVFYhM@Q4tv7{NMwN?-8Ku8G-eOxwZUgt(3=6ku z31x;jRmhmiv^Xlb2w?7W5OlqdT#XaE5q-_MGSi%fF7Ds>Ic$5Otyo1~V#Yyo$>HZh zPZe}g8O%F1w+%SQX;*l^WxmvUQ&N5%JYQ;hfA9Y5s8Xx?TASV~=_EpR32`iLB7uC4Lj=X$lBnh3I zAtk%flc?{lm>QjJhL6FP*IzJugn z5FL63L);PtTf0G#iPK0T&aY7OESEL@kG;N>SRc>->6$NM z2j0(*rwMhfDRh0gf$lx8dvfpYx#D2>k7XT8!~5PqGifS5zl^X|?z;dW>t6;)d<#^U zqpau3c!`tBk%yTSPM>VZLXi$PMqeV1LgvwnFtkPxPgjRfvVg7ax0Xr^R;&%IPtWN` zA5SCheRx72%iHFEbeJaExY1ElK+?^&?iS>TAUdMBcMr@A%n{(^2RH+ud)j7?B;I^^ z7rkfli|k(%_b%e@w{>p57WU-$O{YdI+TV+mby<|-#*lt?XmB#+(b(wfKEBm`AY(B} zAZnYZD|DDnpBb>>Q7ZEq95BDq z&uh}x=%dYlNY1S?M_&pI&)5JYVBPFYqUc-8!Vem&)86BebiW?QAtFDVy}0NH26r_( zC_^CO?cMW|=e_!Nd;`}}wIe#2rjbs;ifve-VvB7)GI_S+Nsq$S5JY$8#w^grTZsOb zUyoAYclwpn;7>Ci@(v@DI(;8$4<&tHXlW*;hWslB|D-5>6-zKX+2bVjkSQ8?!9MgK zl=N~I!}?@~Kx<^NrI^q0srRS28Q~9lflYBLXVmE~H-TOQPE~(*4@#$PheP8^EAU}f zm+WSP;g*ei&p2L;l@4F7HzwvVyZLh&&an%n~F2LIKZGsoGGdXNS^^gkCKD8wC{ zOn978*5SMH1Cf!Pil1ixa+!!Ro4xRSy)@zYLPs7Fyinlr`RnQAu(hV9V3Uz}C;^ z-~Y9jxm+%8+u;v_3xQt^9}E{~dg`y&k_IL-boMLUMr9GA>}o>^!B)g*B8rgz=En8c zEK9pm`|y*X?2q_#wSx_BP5}w*8X6!2tqcCUtG(2FdmF>*`x6R~l!xbak@?Q#VXxG=k(YY-43Z+D2$B08B6(u7e=DG~ z*%5MY)s?k;<$!wd{Mz})9SNS2BBclkhNAYGR=Yc9eI@Gtv!DgL3xps?>l1#V*6K|I z@g6biLi{Ynk8TBO%+c=d^WA~VrcEsG)?TmrPdXwVR*O*orI~)IESKLQEv<$euHRV0 zUPn>T+x>w-@sS`pGlN?9>_rh7SfhqmoWUbl!t=cqsYqT!VHZ?eccRCm5S-9?!v&=- z+Jeh%?!&){ecKh#*;pOrlRLHF|528F&6}$#V0U~vK(#a_$BEQ`{zWkUKYenVJE9>7;rk|eSgj=7Uhnz3xm0Qy^^Hui9 zY7}x$DkL_sWncCgDbupk5VZMn-;o*FQ1Mt z2U`xQCp(2}Bg4`+`iC%H9Tf4sY*L~$W{*be^*Y%4MZV8(`SR)b@`qbsSWL5$uZ%GF zjM=n+$!a%_F=CE3MuW3+McnFQ1MtXU-E6p(YrX)pV>Dqtp-+cnY_W zd6t8G6`!Bvka-in3^?bveED>Ixf3Gl)fQG*Y`aenBlz0qAXALrc|ep17;{X9@R-8v zbs8||w|x0@eEHTEGPjTjRUj%~kJ_aIh4Cph9?uqYMFN32jbQ<|1u4J2l3al~zvauP z$SrpD^VHWJ3&Q$?NSEJQ}*?%ctYZ@oc|`spkf7Fia_oS2yFCcrly1 z1B*s!8Iz$^^q*A|3`=7QzC4t=pD)K`zthg^Ep3E}5G|MBU&RLp#o|IPI}ghR$q+u@ zJc5{|sde-oO!?>VTH%FCKcI-(x=FE!a+1wn)^OP3S z(e#KhTllu^uAeWD&p01Gr5^Y5;c%fFa$K72}j&d--OdYuktp4cwI{afY9wWwjpF#aIES^M$8mK{XJxHGf9|=N=EJAbe+>37@0iVs&W_;h*kQQ?1r-@eW+XFHl4c>?#k=+r=%NW>Ns-Y9A@!k)T?e6*WHg!^ zZ*0Y^BoAG^SUXT#3*y5Xg0uru4D^-_w7Ja<7f}O-7K+riTwU5)p$~=j{lfnLnTbiJ ztqb?QEjgM@GJobA=9_=M^Pe-{{NpBw-~L>F?&eA9|5hLVo9&$cPoK+Qju$*3*X&2z2QXa0Jn?Fjrh&=BsW6$h6(K|%>!6&+!pvWwM{YSE z-2liDar?!20&>3lzSo(znGVlddBXUF`MD5V%%BUKj&q%DB? z?(HOR|MMsL%d7R%4K@2w_Mb<|Q^^Uhgn&XATZ;2|AYPH?##y0*@^LUOfpalPq!6JvF303@uKISoQlV}P z;dN)hq%Sw?ryFYaqwE5Y!yq-CZt6$H z#2>jt`9vS*VVD%krkk(_CHEw{n=AF@X8p8Te_pef?agkSTuDb&SHOk(^L9eyq9lor z*!d1Y5E7ImLI=ua!rZa?6dV^A1}7KA)>ih>xDY`v_jyH+B!yE9gV&ovv`fV)MfWhzOU)&HxmiDL)}Pnx zy8SCjpR-l1*1x;@QGd?Z+JU#FR!L$ZLW}^hTu4yAh@yn@#CC>hw6)NkH2692`O@_X zew2#*_2<$AS*3p3tUs^W8yf!5EHv``gq`TK@^r`*qK;7+j`0vpxpx(Yp5vD$g-eM9 zH6}_iz+3_=Lp3!9T4*(@5+yFCWwqN^Fip$M%(wVx5R#GzQ$J5ljbNE2WqEdanY@g$ zu#n9z9G3g#<^B8jjTQHY4oh$-iHqcKEKeMcz4u4{La%=)7%a6{daG(5?Aa&#PYOXf zh(*(6@=2C8MOG9gPWF`SH10itp@(GrL@D{qK-xH#q@m^9#<5jU(+%Vb85aHSqaLE@AhvVfD_AhL| zf45ltDTva)W|!2{Sm z86>a_1xtQO>^f??ee3bw!=voDab>}uYT0#Y%du9`e(>NYhh83JWevavq&4tvcmd#d z;_(p^-~jm#SBQ@2sfOHC z02lPvx8w_uh2!BT_A)%xW$S;~Ki&T6n&S|1S*MR69`L{Ipy8nczO7)95$-tB%3$2U zd*s~dA7J10>>uCu04Os918r@$0P*WMeK>5jMAh@O1%{n}WWo%C-6V9DbE_=dA^3$v z;=&0(5DPo+ljeOMpEF#a$)zYN0HaVf+J~XyG=CjMy90W5)~h{-pd0i8zCK%x`Yd`n zK(4#{!m{D+`j_%&8Bbr$ID<6}(a6Gy{ft2J7Iu7JKjROc7Z9o;&2Z2{K}W6dJXyxG zWPkS|TMhC-R;OdAAK!qUvB@Mux{Nz{)tT7JFeV`qmK^`4#L|A!aY(Z zaXnwzl^OErpkBLubZKJRdfmO5Co{G%2x?@Qb{mG|qB!qc9iQ|^#ydJrbay9CA>?1f zae%Nz^5qyO>Zb!3wO9aiYuC~eZ@1sF542&fQ0zr}DnZvt-Ej2^*wM>@Xpn4X&Ax6x zj^3q_y~U4m$C*7o)K3-1wcLetu|!?CmVkU);Bh*Pg)FRWKEN|l}@@xnE+VKi1y@|grKE@d29@hVW94nddvm$4qF@#)iA38?`kMa(2 zYwTE)C8**5;vjk5s9+S_|0@ts!2e0iPma&S#*51^=serm*Vs>^+9ku}GMrO_zSE2N zLeCi)PjsKS-2Lz4)Ht~L7z+a;>_RyPM?`hUC>Rl?t)a7BdVJ2?r|sk+=H#KEGo(#& zZW*p_5X@n?UdWo5=92Q)dx8-r=HGd__BDaOFbg${6W zaB?IT;lI3HZAe>L8kYUhKZR}xNvu)P^hf_V7!U?*tOKbv=?^6{11&C*FmiFa+Qv+@ z7TuBr{1{sGj^3^$5iF%wRu?7}XP1$wRwqA7M_Ee?L)mJ}^v?7{7=|v>|Al>?_axO0 z`)^@RYQE07_w+vJxzGE)=bpS5m=6p#whwX|*Bx~(JGp+^cBp%CA>X@EzGo?k?$@gM@@XA3JdtC;1BMaq#z94|#pA zSblq+=4^r@uwC3NLk-o3i=cwX==$aF$juKEYOkB@LO z7Ru4DiFqxeK}|GB3gE`WD&pP4-20>QyG~EoQ+-|lFE5`t>DzEHBLy#Z9w@1G%48NW z4Fp{9R${JLU#Kz(+d1sDLs(*P8P~=FjiqaTe}ntR0cRE0Paiud(=7|WF6K9%o~&*` zcr_OfXP{w#T_ye($O-!CJ-WlTZ*J}r_{;R(FYiO2PYLk^_T*9^r?R}9cp$nmk)TxE zLLpP%2;{HliSvXw)n`_ot#Y&k@&p^-=P1m7357@`u3-dd{0QX(?jMi&NMt_owo5|3 z*FRbQ1L`B1uw2QBL9`9cGBndP3JQ)x?&0xgGBwP|*TSTH%uha9w%}Mi_NO)kopsCt z;=F-KhpRpVuFnPrE0P2CaLM~C`vWxqiCa z)@^h2N`CV)-;8g%d}i8HJw2X*q-RD2bs6@z0&|KP{-tbg?pOHJ^6z~N!Rd3wLBO$S z^XlB?I}nt%ipoO$T_Fqr@6Ha(vz?t+i7f@Wz?Im3dH=a+dqg1Lo>xfI-hD;v=LtDD zJ1>w&G!Wb}*b)8+tQFA+`M&-sX8b=H*wGowqLyfuX_U}X1aW3DnI#R-NCv%*Pj!=2C7QHA3)eS_FkwD{$YQAhj%#G^mTu*B-j@lfSkj3 z^poc>p?)_aRqt;;}`z4RAb{PNh?NI+sq*GA2=eIP*7E%lh$h$p-J6 zTv%Li*t$ErJGuTGKHrT7KVTg6w+F^JnMHgnlc8X!Y1rF>9YegHyH#;ht;kU+hIMes8y?Bjt{=Q~0N`J=28lA*{@BFxf?_V00KyGLc zZ!t8Y6OU8Fump1KRzYqU7>Rplr7P*iDnO2RteG&496k42uW71pli)@!mDYiGPEYHz zvss;xd*U^jxlu4~T5g*v6i4L3x!SVMHrp{-e}03%PyuZbbs`2@8wA5c6|oD!%H)ON zCa>2XeDX&?-hZL5qGBvYp@(xG@WX>|a8^aDBtJL&%tK{7aX5v}+zO&DBQ4|A>6bG(`TZ# z#t%;m-+#Mn7y>yUeB1c`r%>W+0;pyQN~bEcll z0dO;&0@kxSo^;(a2ZABC$8ooW$?$@v^dd}$sMr?UB)@sI%E<_*!OaUnH>boQzc3I= zChIHVk~evWKeit(Nmd4vNlu>M0^GN@#H<4M9;G?N{~!BNH))$pu}_A84zGYu^bDV0mm14lT~SlmoA^kU z@1T)|%^uvM@w{{OEZPX<+`iEGr-zhaLeBjQTEF##Q7qsqij4$vZMHe8|-k-8PCs6~sXt@<3^0X#ifJ zYmAfRN$PmA!`syV!4tdP4wiQ$JNkIFA5EYwXd7@ti=auhPDut>XRFK8MPGDqE!Rot zOZ7#ldYDe*h{U9xj6|jkl15M9Z)=MwqKDoV1-v>57)+cRO6SNW92t%_ZKebcv*00+ zh{Ar$c=+b=t|9Dvw_bboV3YM`PQFz24}X2U{pq{gt9n?#t!=0TWWvl*ogvb1``_9| z|2e!*?|%R6`=4`JAP%T!iMFo)0<>GRt-rK#D&;&Syo-d}DBJLr`-F##e(Lg)-+Y}rKBaBHumqDMK=C9B_F zbjmb!IpS1`Fy!t_OJe}Be}msy8?CC9{M~t5XJ==f4P zs|jyy6^trzzoPUe!!NF=Q8+RB7aW)HNzUF>+RWv|JxHUZ;3TB!nc-c^)Ct%BSx?@I zC>MIn3WN9hf46=q+e~h^egS%Cv(3$|&0n#Hg&*X`TF?3?Dpd&cCR-X><=ZmswITz)b-g- zsQHweYoeX&QRlMC-_2D;2Rj!&bSyaXBI%OZ;`2$l?=xI=YWu~J>N!LSaX=2^PR_?Y zO6O0|tG!Yf2EzVVIY`oqq>_V`lNlTz;ewUr2KTbx-AMfU)^1L@B(UeDw;(`zj{5M*?krKO|L&2$Sxi)o#+n zncgm~q*C7@`JV5o_kG^C-n>B|3azO3xLkTX&ia-=$o}21SrCi^<^Wntv@SlM$an>| zsxUEcwian+o^b&tE-nx)J^2$<6;@yh;lnd1EW~VYpZq9n|C6^5U-7CH(@X#7XPTLJ zKi@#X$DiK)B%UQazkWRZDxH+?1vv4(uNrsXACLb#o=jh-0d(WE0gBtrrgil9ojoDK z_m)K9vlLl^4G+uu@ggYx$C95n-TZyT_}C6>yz@4jDbEVmnMmZJ5MywiiSwA^Fu%eQ zWFXG-nKDs_J%8z5*AExwS^6KJ9_KAl*}wZSP#@v z4OsJ))wG(nW!uS4AR6$|o6zL@H#G{q^A5Y_P^u?qMx{r5_@EDnVfSSytzg{ky{~EmH3< zISG2j=?e(ZWr7#Mfn|ZYNne@+1LX0zKLi~0!wK_OHn}Rk>r9v7^$>oWr#54tv1AZ-) zPmP)NvCQ*~NGm>gNhhl73+p!(|lwi6D8DHy?kYV`#y z9(4PM4}qQU18+e6RX9}m*R8G9?XB%apuhNr(K7be4KX`82S9; zP1um;k%fPd+aT(Nf@RqS<9$^802Vc2r7hmE1p3(l5n zFN3N47|aLpO=z)8Zz6H2Y@90&ubB^pOwc@K=IgVpe}2B}e%f=3s3;yM=%W7I)%V}@ z?_OC^bCIH2q)~@h_f;g(&wRW;jn7uC0`eCkB(843&A$kU1W=Vh6fSUp0m0IeD1VGb z*`Hzm16P5V@9nGx&H}@YH?LRaVKp$tDK?L6!6%?$+nhQKC(+=6FASA ztfDNRJ5IEOxf#;nQS*Skp3ey70>pQPL|>Qn=U{ucG)W~i?BC7$>2OXh!k_rsEoXbh zNzvXC>8}s_csvuNkM7B9Alf>ME=h|h8wBoDC*IqJMT<$o*}S9y#1W72hhyx&%XmR< zhTJVfKr9)}2V*$i=@bgs|Hb~}&hY5t@CcRiaQ>xf%0ky1#k8m&pZ7qekgLQm2sKi# zn`0q3%8hX8;S#7^irtCd}uAhI4M}>Md9A9L0MApc=UB@7ro?1Tm%E- z`q;l4pz}jSL=vX$qicb^YdI_X`>p8Sqn)#l2%o|1?C^=Y_K|S89RHys=WdWywjn2P z$juTI`#+3#q`FshJiC;Z426ZTa zH4`AX7TeU6Wo1UVPp@_v+stDzHbY}r8ev;%wY8W0YRjQpkAvwRkNDXqe;i9&0_d*W z{@sxkFg+Y@5AdPDbt&61nZH~))@PP=!`{!ShA-6$Lx_V0#p%#reg`w<}`0l9$Q+4@@8d9r^X0tj&>w3wavvd2eQAFk%q+^7nQ zN7UQ?<>SNov)Ygel`Dx4G>7}J)(i3u5QF>-*sFz1VaKs~&l8Gr{tY;;+;e#0OL1;f z6G3SzMeR~AXP5#DvL4{6yT|%y&wP(p(d3-&clBM}exJ3|cl&$i?lXru;607vKlY17 z6};!}Z22laDw~K1TPqPtEoY_DTH;I2`^y-=`}x(!x1axR|8m##L0{ay>GB>i;Q-jI z&u5mFHU%O6S}>TZv-U7WII&B7V>85i`F!Iq_Z$jN#OP4-=2vC{#)VF_z7~}AMNEjX zXb~6AmCh16e;f{DQj)zpJvn~xX@BoraiD(p9X~(fvysSvGzqH%JV(@AF}%WYIQ=hv z{L}vBu09kS1WK2`c-wC_U&3OKcm3m&U045; z{@&kyEBbpwzCRv~jKCP;5@i}6v*dh6N5aLH$}9Iv8~^40)- diff --git a/website/docs/tutorial-extras/img/localeDropdown.png b/website/docs/tutorial-extras/img/localeDropdown.png deleted file mode 100644 index e257edc1f932985396bf59584c7ccfaddf955779..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 27841 zcmXt9WmFtZ(*=S%B)EHUciG??+-=biEVw%f7J?HT77G@f5ZpbB1Pku&vgoqxemw6v z-;X&{JzZV*cFmohnLgcd+M3FE*p%2vNJx09Dhj$tNXVWq2M^|}mn)^e9a~;bs1CC4 zWs#5?l5k+wXfI`CFI{Chq}oa9BP66(NZK0uiU1Kwn&3K0m`=xIMoxdVZ#+ zp?hKSLSSimjhdEzWp#6Tbpr;2A08YY9vwczVR!d;r)Q^kw|6h$pbtRyO;c2US2)Ho=#3q?{4m1GWOCI`k&9;zl9YDhH|l{oVck{{HdF$xGeh(%RX@ITa1V-QE4arPZ_3^N0KUo15FS^Rt74gNyU?f6HsD z>zmu#+n1LY=NIRf7Z*oIN2_aF7nc`%dwaXPyVf>#Q`56+>svGPi|1!&J3Bj8*0u|a zE61nDOKTge8(T{&>(jIU{?5$PF)%N#t}iaHQc%;Ky=4F7L{Hzy*Vp$Mj`%zGZ+7k< zCpRC^+V1HYCi6}{?rS`Ew80CL%d5-LF)(<1lJAQ_QE}I< z?$m+XE%JR|)Y|g5*Z=3YjLfXkvht|tSaC_|$oh1*A78S&%grr-Q|oi0ai*n%^?I3Z zz4Ifn)p1zW0ShuJU zjT*W!;4n~Y)3m5E=4m0n9;cN(k*j`y5!~j2)ij4x1#tx zB&it>z`(yY6BF>DU9?)rvOb2G!4AbPa`$!ju_}{}N=X3%ljy@XN?Dz5W~L8#vn;(% zS0y`!_FK8bT{5iuza9iPzyFntcC0hEUgCyxwZgrs_lXv54ZHujy!d4_U`~v!&Xq6w z_%CfMkDLt!D3SDYg>XEZ!YJH*s~-dg$LmS&Mt_;Y7X9a!>IDr+ded%2&q%}2^ODhk zoJMHe1;<*D7+WnelW=pb#;#*9m22_D0Uy+B;{x z(r=4T(e9>b$HL=1ZhtTnMZ8m?T*4WlE1nANJoY~M+S`a~oAzPxq?IY|K;|faC(Qf6 z6st=g2Oa&+>GJF*AU5<{Q1pIIjk9IOz}i1XThs0R)dBg}u}I!L^(JejuqE{$Bx0WH zK_L%2hekVKCo%({=C&4>8XPbm?HVjtj7;pR;Nl%bO7u_%gfl5w5S;(8b>qCb9KY=2 zcH1B8#T*pZQMR+_zF|mDvyu5p%arE^>?K|9F#FDuJCyu6$KPjjPBMq7j0f$|h@y!QXH+UdeH3iv*9ArYX^V-S2rxolaBRROkUH4!AxVghY-$mqUuOg%w5X}J1K z3LIKED&GtI+|Bu|l2OgJXS@ z##5m-UU-??q5BVBs3e%jt&;*!MXilSO_r%{gmW&qj$2WWx8M1Us?Tzp=Of?r=^y=m zDDr>5Z2+yUUf9O3Kqm?KxT9VJX#G6EP&E+e7EkxJF5QqcBPy@TsIFiD!!LWKz2ftR za<|^DinsXw>aBe|0DWOEi#5cV&B>!$i8?+vTr3ZDMK}XFeg)Ime5=*V++LLjj6sSf>5d+I|6V|cU`LfQPC z;p|(TN|j&~8CO`*qIi-79281;uL=cj-kt$ zx5MwWh>2LRlqjdUEGgk)P@$`Rs3-3sSlqxdxpG@!K`;a)V2m#wvau8$FIZuT9T00v znI8L>LHCkAZsu+5PUedUKs5fY2Ehv7Lqr}Ue$h;p6jBeeweEDUn2p#fwkvxk%Z<-6 zlgcD$>a-9H1#>^}Ku>>wLa`FkP^$V?ys$YQ&1L$o#0R}|{e?+I{K?~0CPz_*Bh#mo zh#!|PeV|ebfXa=JD#~>$?!*)i)b@eZZ`$qTk#-n$b{Cnhx2wH9N;PkqOwfS5FPe4A z!^5G+7=f|QUkN8gZmRRF-gxA&%`!7|FLGzf?uPu9E>P4d zrO@YSB$ z8Q{^@GSty5G&7xHSPy#pErSb3Yym^l5+QhvVlc)ItslUVgKOTQyYw8QX+2%`A%uhb zCJ{CE9{zUB(&-v8uRN|49S2Np{L4XRjFWz9R?)%ikl#d@WJtzM$=odVE^A1_CR5$l zs~b7y&?qM}RqSq1_-7&^wqiGh$yZuM2alHG{5LL=^QiF^u2prn!rcZ9%AF_!mJaxS9)8?8ha{9;`m^(Fx7`o(9*^- zI+OEv7<`;JEbKrNAh#EhBOA3x9E1Hr;lS)5pbY@p_LBMGn<&!Nxl41i9>dX%V}P+N zR;}+{G5WqCjnW#@f9ZNd^d5R<+ViQpx-L3$P}Nkiph3->K~K9)Sw$@INj*8YJLj@f z*+Rh+naB!_+NtSnzwWfLhq1;bmSozM80Xik(oGSLM*c)>iC_Wvd=JP|df1=roC3iU zoG&xR@$6d-6s0^VR}3V5OFQndgqfbboOay9Tf7RQmygGWgZ+DD(=|p9Aw+)O_j8?HRA#~+mIn^!H zQ6fcNW1FIjQ#SN_nK%EQV_F{VV77VfT5B(ea{vC|K#&-RTdcH#OR%(Mr#R1?jLzzq zSC-hN{(b^Ik^Q{uB|gq70;JUnM+#nmHCHA@PxC-sYqdnHZfEu1VHP*(8?jf)TsXH7 z`d(w{qU>V+81-UywGHL+AD7SV`|6-5PENL9RC02nnu15q_;*RRA_g8|!M(z88r&2? zCYs;1K=%c4QceJr-h+O=+K2tbY%HGQfyO1=9--HP5(yo2@2ad|TVK+$67(dBRpKI9 zcTvYDh?n^D9&qCvQhZoHb7DSvql}UJ8B+>~m5-ISatyypAR9WnfzbiDmXq*ctR3Xu z(~YwCAKYipx{EI8!HwsIlC6i`0rhcb>6<%+Cp)h@mK*_1d8_q6dg4>n}&ihP)NGiUvb81U?bXk&I< zbcqui@YB^CK-jFfu@*XpEERc^Mh(aJ)LBA@| ze4m|#Gs|Rc+0u4VvgE2s^$ ztYjCc@_u6&>iu~fe+ed*pr>hTdj(LcVf&SE`t2uXleZ(mhZd7kd|U$5HrJHPQ@IZ7 zz1w#&@Hi?VMVg$?DV~d{6LYoL8SFlWmuiYZxE8-M?^q32JSt7GoOVzZ8#I13;Ax`h zy=DXkH>H2B>%O@Ual0AO#Lh>Z`q=%r{iaZi3fZKcmBtmff&=e!GF%sO1~^L| z<3g?B>etUeZ?Suv6A<@bH;i=|KtG0mk@t4!qPRX4+^*osf+?77qg=U_OjVUxbTvh% z8DC!P=LlXRVFEd#m0i*Ka(b7e+3E&CC^Yv2#TgpoU(C>Wsp4))0%aRYtPxSr1x zO6uJUAMROWMj1L@;~jX6gRh(+e1ZqC_CTY4s&GfB-E;b?6+vEb;^bSE6j9xTFW;oq z9(1ndc$4}qdAB6ta4BN@p|T{**jB2P48}=Ya*Jc5#3mv|J&XRD;~yH>^DLwT>bp@)BbsVm+*3t=;598_Aj{ zF(?v`d_@ky*e%9dvu#A7+LtE~P$5VDCRJz{ZCt3Qh5aQ==>mF~k7bTCZxZg$!jnP8he7?WmJYT*1>c{*tJR|Ie+ScEevd4@gG>!gnL_ZL0 zKC)4$4wIXHIG~yE4+vZ~gh~Du9&92xJVUy91zt6P+$SZ9%)_wNU7KW~uGu2PF`KM6 z)UjHJQr%bRkMmIKABTD;BRcKhrdAbU;gFURvdg`TDW)T{)k8(vFbmtSAMueO{E8RHEQz-$F2C0;smk?8Q*e=qM%6O z6aGCJV;h1Tf3qvPEYi~fsz?&nlrg71v(eKqA!&F7d&p(^Xy#{`bl-!6%zc6pwsB;^ z+s#(uj7tu(L!ti&l1T51?Zuxg`16)sS-XNZm6tV-9#MfVeX#M39*XRuyFiJrxU@lO zA94#H%u0U~Ea9b26Qf{o;FeeG*!6uF*bYv#%%B^zN~9gqX{FS&&Ba|4AuSA${f^sf z7tg9}O%6m})g#&j5f%_eXA&}AZI!vQtzb=^sQxVZi~_}R^pgdM?5WD3%5Gx)%~qaP zgb4y1pEi3Ut}qG#QQ8SxhEkYe1Iy%QMz~|VS zKNsn5WGa%en;uc#7;LpDxYo4^@zL&dT*?Movr0f}Fry~2?+=LVy&$9SKV5+@SE-{M z4E!tmqebqFV%O~LO=L7??~zNUu90ECkq2Dut+Q$C#QJ*uQ33)=L?sH^oM|)e*HvE5J+C=qp79zhoRrLcNRA%1 zo?(m~(so82vOoC7`kQMWO5~^(`_b!C)8yq_VgnO5blD*sV`=DhQ}{$VtHxJJ@hixJ@hcZ z!Y6lPxZ6KphBnMJ)Ki2qFXY=iKs$GnX#1@Z7~hW~TuZju?)u=y?>z5W?Gv0-coA#k zCeo>mYl2HbT(xw!L&23l5KXaDk)yq}eBc&oPdWOPI`+f_o2cgW5QeU+)?Z2SHRplP z^{WM#a*z=ndtAjrTjbW0xE@*Ir~X+Bi-n#;6t1um9|^H4v%4b8X{_t71*TeupTOxB zM!=Yir}l!cM!GzQSnjS?@tOr){-JXhj8oH5p=g?cX47@jYyLLVq#|_Nsv3>>?X=ey zqHoKr;KTdI-GBAo?{+YUsVsacvsXS>8d?dLdU_)>MB*glDaE}%bBrd^98i+k4NQ8s zc0?8Fbqr&)Wq3Wd=YVyyUH$oZkbSRGYQQj1NofbRth{_t5aE##Z zRgYXbJ@On89x{nXLRlW`84WcfoXw=cPcZZH9T^b zcb#iuU7-qyv~G@U`}AkosbCYozUSeB3Hxyoirpqhcbvd|soGDf8>z48$4OE>XaW4E zM`Bd>uV&vA8~mC0n0*yWn z!;O|1HnCN1ghEB898BR#@4Bo&&oP9!4dcdtLZ@`un@&0 zzvF-GJhEY|FLF{hrM=dB7|h@3bEZZVJc3@GCJk0{ONwS8^g2F0`roJtV2uvN1O)|| zIfYh)=}lZzT`5BbTHcM6zo=WwB7-gyvx+Cm)a}&MT+1M^^h@h5kMVlZF*~3?Y5n)L zG9~s#<;5)1%>+_Ny*GZHAebop+bfp3&+eUH&4)I7Bc%5<40;DxP0G8{l|7Ufj)b!u zw?zWRNHyLJzYlCQj^pLwN#g~68@bp>+KA=l8QJkW-|B;3+XPeez-@9TIs${Q*6_9g zgZY+gF6*%)arn3AJUkn5bhfZ9zut{n6VIK=XKt|=rtOVmc&6zImd8%#b}Bw)vQ<=y zZ*)E`F>yPlf=T61Cm%u&Swgy**c63kVp0V|yM7_vkz7jkw+1H3?_NcbXa2QR`&1S! z+&YBgY5aZe3Oz3Y&y0-J_SoE$OJ?^Y5E^umyENba+t#hf=fjWb@y_QD-S_*?k6rg& zYCqi76Dk6v!l>?hqKLvuFrKkCcX`eYORriHtB{LekCARf*i6xO%HyN*j5mwg%*8!T z_-nF5R#R3`E%JC%un?Z*bLKZbmC(`y?h5hS4~y5*hgyC*ji|t|>+*|`-dcqG*G|Tt zEST8(?OF|TW>rp<0OymrGE9zAlwD*|y}VO>>~H8Z91s2Imik`Rq+^-6$BW;-O~_dA z!0~$@ir)8VZEok*1Z^bx^25FUR#w|5ZBYL3o!iz3!TIR!4dM0kJ3M$Uu6oT8;CKYy50-UD6m_X=r8s9+5$+sA0zy6pqH_&Z@W^+??+HTsDpji* zpJYPs-t|l<_3g9}ngwho*oRGjLvmgR^?mB%vOAB;nrI30-@eap3v)1iCsy6LJHpO1J< zyJZ4Wh4TL8e$;A)3J{xrvG(WSc=))?Jb7Ude7PQzrs^QKFUs80=y)usVamepIs@|w z`Iz`#mm;4!p8c?~+N=@YBv*C$SE3I503HJZ0R|PT!IyVtgvYdpEy__RjV?qXKeZS8 zQn;w-0EHEP$J1*7n@+9+ndkivReVrStsXO#HIyz74ueJ3uc5Y(sVEe}?RntR{lQiH z`Z!qQ;Og%AD&~>mulH;=Kz}3H2_E@LZb@~4srs2{vY?%@)Kl!Nap4D79D{9}Z!`{& z?#?MOm>og((zofbkjOl>6O9@pvqoooVcjc^C-#xV?L|D3rXAR!rX4PzRkgx;H70*D zI_Pqi!x-h~CVp;&e0Ji8#XXONI@+S1=SSfqMQ>WVhhw!ZpqKaFLfG@O*E!;9JweoR z?{TX1XS6B@-~)hQV+wZL_soD`{+?KKnJh{Y4z>ugj&n-b6_}jBe(jSLX6P z&9H{W>AHrLNjvzbPKRmV@tT%0mYUCuBT1kvP^GO=`ICpra+8UwYXrd(pWPuzm_4{& zWk{u~y0Zv8Qlt(vtPO(#zX5n?`VDW3Ct(plTSM;$<*Wqlw`Z7-AN6CITh2!btkaDu zrf!`e&u14f%tSP&(Dnr<9bp(XcXW%tYO*s963nBWA=#0746gunNA6vAeP1s zh3fwN_Xo-D)nJ}kr8L9iLhlp8zQQ{nY4Q$@E9VtETvY3caFqEe?wB~cpWg4cy=Whdd?Z? zXPs;EKDvGsP6*bHo;Asedj+UOAyPE`Cwl8av`E7KMRPx4{M5Nm)na^3~o1fyYQucv~N{FBO$#$%a?f> z_2b|tKXBB$5)5npHFNe?Zy-grTI8sM+$}L__i>e2nemkwx%9r!i}lDhBEL!$_8+d6 z#LJ6vr&OO=-?Wf@W*)yvCLByyX|NQV|ecCy7=VAOB)9BI*Nhl6$m2&;G5gX z7X%M-WD-iH8(`K^IByV*KC4pkE;Q%d_{*#4?^g1OlJz4do+x=4js7@ z4A1i5J{^EH#kWeooG$|j7@#2|@kwpNNOp2q5tS?TUv|0sCwg@^U#G?D|NVyEHk3@4 zh9QWPx@!?z6UooVSfd6QY0LCJiII2vLNZ0~Jqnz~Z^l-ou^A;QU;}AhM{s6oqmA>R zx?|OM=&u!W1Uio$0m&-Ry7O|=MSkJHZ2nMCm3cd2v986rcYhXj>{)~`rp~In^`jTf zFrXGkn7tKYRu$h+~JfC4LO`D=-Is- z`O52#2dQHUn`kg1yFQXPBn)1doD3>%Z#Qc1db!Om^YRfrJIQst z-;fRaT=uTy2I$-qS|{FdP~V|NDf7ik?ZkYCef!_RSVV*5*a4(SshTJnq8S~a`-xao zsx;}%hcFK5ULvK;gHS_-z^^qx#frvEWpEI~{rtfbuS8wSnx+wfU>o`2dC=x3`D zBhoCot?)M$PTo$u&5L;JYCKUEb(v4VM%h4az4C?X?!Y6cb3KdhwS}?e9dC7;HdnO7P%wI_DM;;s)@@Z%bXbtAz>;d_JUlP#%eF{9 z&G?mfv!)Kp4BGm-`S$V!e>YW%_7wOu6Y@dH03UOV54u#?t3zN87%+2DV4y8UA)tjRAF;L2r0P4{}i zS>CSrwAQsVg`0^P+-P9(t8Inr_eUS#5t?4*HluhdNj63cJr5&s250OW1_Y*Veacuo z)0zW>;IdzS14@>TV9}D^5NujBuLsVE+*^zGaRsMzd40GW&lUtN9c}wb{~oH-rn5i@ z8}x~^(V56NJ>0RjWulsd{#z*g#MP3;$Kift?|Xb^>Pq7n-uera3;fa&%Kqq+sTISU z>9I?T5p%nzkJI+%EB3-pvu^_`-K4BPitQJr=<|A1pF^2$^d||Im4!Lx+DZc#;0d%Z zU}NxmZU|4p(!59eAHdzA{rqw6Ka=ssc2YVTy@Kr%TweSx7~PHI0$Ux(MH2xP>83k; zbDo^brmW`!))Eo*!~#*~(W4nwS!=Y1;yzh_{9+ERu~TOO)jk9Zv~B;)rYQX6mHFEK z$FpwAYy(lY1r9y+I7I{>9?geW)UF1iXT09htM#|*5w)gCZMKyi*_Ji;8TO`jkr6_D z6d^;@Cn2~1@1t9zQh@LC&YnCIm}xot2eOM8;p8qUQN8+;{_dBN&^VM~s_~5G#LV6m z_E3xKqtq!foUe8JYAMWpG6L66c?}#MBe-snYIx34#${6zQ+joY8Si;6OdZ&ke9RI9 zhJVE8S27lRcxM1to&zo06ulR~=)s2%EoSb-}Kq8vZm%56`3bWG&{95m-EEyf%f3 zH>Hp1P(-{>oBt2RmrZ0^^02K|$)u`-lkn!CnYo`C98s@Jf)-Nt3YGS7qu+WJ#ig-Q zFrQrF(9BS8SkgJ;+Ad7Nb-pL%EFha^nT1{-?E>u#tIcaiqZ19=37#rTd8pgB7g#`{ z3R`W-FmER}xBCpl>6-zNKPtsGV+;sy5|;j2PzH**0v8xbiA$I)z;nGF=f0kD;9o80 zk9RY17@+hFh@PzHbGN#U;3$|?cr@7<-4>(%aAapZ`iHIwt+VtBy0LH(1}{C)3kg3a z$axD|Iyt-X`@2lAY5noiw7Ges2e_Qy#ZG7g7!r}~R1hs0kXTsZV6s<#V!mFs#>11$)A=<$Kuz z!efePeRv291X1dfQaDLD&pz&rySTeJ)gM_}RHN4$p39$|V&}Hy&}+?dW^|({y!MySY<7Jzg!O zf^s9Ppls*TLgM-SI9c;jdIIB_?_E}SC2dbL5<#e@~e!>h*T}3V7Qjuwb}kpd$k{i8yIhNxcWp5 zmhr}|T%BZqGQI3rUBDr76MVryhwI4_s>U>$O&%JFqpibpT73JynWfVyP9vAd8#TkF z@b21lX~Xp&JvEw!njH%gzR#bLZ(HQc-x>V%ncNiNZVJK&R)GfUJ{=r%@BYj|e?tAE z^QvUXJVicpo4=Ku(9&oBMNT}AFs6q4)YmcNKs}&Yl3qAPrANKvAX)cQ0-_JnGLH^% zib2!LEZ+!2?9Xjt;Vsr#lw0vn26t$134ju@;-k>6A|D<1f9{NA&6lpAq^(bHU;73`4+N|^gyuiqNV6V>4tiHuh2}gS>rpliJMYF> z8oV`hL{!l3Cr!jFuS`U(PLYOcg;mf+q*tapy-Rrq73i4^Zr_D8w5!nj+I0u!FF(jA zaa|Fie9MYyVD zY+|f$aJ?0^#q(7Bv(_Rf>!-!26{dkm`vv5_{yhqlfE=-JnrnR3CE&==9oG^BPJ~kT zwR#L%pm6XWo_o>~-xFwsnFCS-K3SEG*9n3OmOIw$y|;&`Jh_54%d_jy$;Tc2Y_spR zsaIH2IH@qw%s;q1T8%_~*JZ&ytt);Fy%vh>g z0w_CsOn#JW{R5GsH?OEs1xr47FZzM7B-{&lNe2bAnJ#CYkWk}CK065tB0jzXv_Ue+ z&!kU}(r(0*6z9AtXe^RO8lX0D<%I!#-wUlmC}2X3R^;0)cuXyXl#01U9aAYGBNq07 zQ0C`^>CvlIsr|X$a@#JlI=!B?psUQx$bJ$^?{z*pe0X~bm^`c#V&s{0MlZ2T-y>}F z;qPquk(Pkc+@>~ButddAyRL%Hp<*0=QjboBwPSW-PHOEB-@Y}(p8aa|yNnqY5iwd} zMW09Non<@D_S6*Yt^2H1H_*KaVR?1$sYP$fe%28z_TYR*uvmX_{;5wg$t{cwp()qhVL2-qx3)1wM*a1-Qko7WOS|m_n5#TglB_)$&TDF_|oOK~F z5`+$vb~~{DgX@<_1p#;oVwb#0EZ3TI6$r55L4sS>BE@dTA#G0aD>84pQZg}wEWXX` zi!o|(wQ#4Y+7TC_zH2&(JiwOOYq`B)ZMOS$()lGjP?Re|ONa!QYMvwZxST#y zqxy;V%ft%25Xi@T@m(kD!pOvW$-@7ISP-Y%N|Ru>0)+_1!Xqh6yx_LcFNm{O`PE!f z1~@)qX~N_wIEb^f5u-?lm)di~;Jr!!^i2p381+NQa^Cc41Q-KE0Pi#aTB>o!<@$c% z*Q&0@cBXHDTZ2s@7*To0m*BYhWJwxEsgU+sx@6~uz6~lY%RS;a{p~AC-LG>IUop{T zr=uIPav^B@XZ77ba;qQ)w|Dxt$Q-fY!I+bh=a*g~Nhdb4cY<~1N)F-&Ui>SR1l(Zm@ zU~{AX%FoF4u=?X-SNV(5k>HE$9dJyNJ1i`5o7!u7exC)~47YqFkDvB6Qvg#`GnW$m zy^C0qY~lL3`HdJoR6L$C-K(+><84eipiDHzaN)Qv$Lvk($43+H>IVoTphDA%<1OV7 zN*wIOIb>eQ)`8RyzvwEjennj>vn!@tYo7b3bB?40+SdR)E#yrS^OTn6TmN05HqK%l zP)ZuCwf1Dqt9nt}M75{7)xl28WCdmP&nv%F5L&v^Csh6lR4+6qW$%QBQl1y9g2m&zLQodlxDQe5t ze74A-pBpIlCOSp+vzs<1{?Jh<5)t`U7lpH47Ax0o_SFnzt-ale`H{M8h&qB)qshbx7Ad#HNB$| zo={%npyBI&{m}+3+ngQmW@l~dYovp+my{i|_PyEoYucnl>EfHm=~;&)!6SYGXW9S; zu#fmK+2v+_G46lfe~J+}-wMrzj+?*^#t`G>E$l*-E7%bPB)Ef578L#cU|%dTi4@hk zp;+bBv%g-&D%NlYIGgkRvGc3A&8QgDxkHez9M?flQx3A$cKc(&?EFW$uDMSdb(QMw9odi zQA?zO%QwiY&D&*2_|La;le8f+v*;YqftP=UX(~GO>fBxRS{^y4gbh*RyJXj3%v!%! zELfdXKw~e(B^eo_RBX;Th4TrEi|2p2@Hg*5bt%Y7ZIk$P-}GUj)gwz0gIBAGiFNn8 zU4&Na+V|69<~TqZyxqSPaeGkw<_`ynX{4vBxwIX_Ypq#9SqSJ=W^R4opKAeSa3L{m z&lHRtdQy{5Ggy~SFu34>`lJ%Zqqg`)p0E)ulwxhQ-;}L>tXPKb-xTPBQs}1)CSM*$ z)G0-&fr8_TI{4boZwExp&4Rt|u<&mI1_Iy+`yv2(?Zm>&!E#z5*xWy{v=^H#tjEA3 z;?O-=$gFu6kw*5=S@@t1PtJM?AR~Jb<+?`D@ni^f9@rf(6M@{G_~V?Cy-fQf^8)n? zQMliUqyBPjXiOCQo#z#uU#^qooR+z_tHzkiIsIG6rn#gWN}koO1iCdnJ2E?}15?Vb zHv1jpiRE-A-RvipUQ>D1lRSvmj z7W3Og%mVd(!g)KZzdxx03y^c4IMqbhs;z8!D&FY;i56b*oQ6$WJxRAsvOKW!wE>ua zD0mc=bW>_*_Ph03EUervAR2#dSHw8J{!GR_N!df0ZL;vK+=3WRYyZ#GgT>l0+k}~1qIqt zS6WmMZM)!rz7z_m`fK9CHVM8F$z&G%jWzFH!hm|FYpam-1QF?Z)lPOHi8}0f1o9EZ zDHf!)*@a?vnvbdJDr!`&Cqj=g-f;y=uFs7+Jzk$Lqc5IOB(A-BqFIgF5T*Qh4dUC& z&KPT!3?JZJ?!2FGI-p$Yz1pL2ZT@|G!_!$1J@*9lY>pk*)lpl#C(!j;vJ^FY@2K3n z2bIo|a*SE!HzHgWM{6~I(^a*s15DV0tUv$zES9Amg!xeS8?y}$1Z}K#^z*n0>1~He8ZPz~6(W>wyBjvX_I$UA!VL?CFEa)<61QoPZ6E_lJpjc$tmFIQ8ZC{iPDf zO2-9y&-i(=bBR|;{%~gM8=O_tg<9F|DLGA&TZU$Dmt&g50M3#7f)z&Uh;BRwc9Fuz z-1wDw3C{{c-~!Wkhp>&;jVmvmxQJZfG-RppOg1^@pFD4B;*!n~lLSmHhRBGUZW=wL zrq<~HsA?@Fl|25*Z_6NPzj7X+}j+I5Z=nZ2_bWFC7 zTuxY^a9H;EY7yk(wd>FO+r1&Q=A6pE#dPEy^vWSAqgg}SUq@acOCxOw#+d|Qm9XIz zRGFSu)D?W`_1iH$=?m+!uJ;FT$Ox9sW_Mi@heywtUNevsjY|GZ+9y&g$4FCA5uwfk% zf*2q%_Xk{=xlxR0V-lrZ<8c^ny0kflt5f{jx54mj|S>kwam*Tak1b3;( z5uPT_RKvI3-JN1xNUUV?slZ3MO>r6QL6oc6t-jxIO{GxTrzD(yK)QDPpLm+v`7|p} z2gy(VZGC&YNw^Sa`UGiI9uXm!9PVra7Ew3o^o&h~XSGDkY zs;^`*cxA6xHK0$Wic0L>UEZ->|DkX6j1#<+RIHQm=vtR9K&^UG7kBp zohssHdJ&9qvGa3a$c)-8t8?K+cH6&N!v~A?-<*cwix;^Kx->T5?74h9@7rrK!RqW( zo2vJoGt#1rN>*x0wCL^Iy~m|a9o+HOx%%|#GJ$IR^@H56PS~Nk&64x4VbME}59a@h zAqcjHo2qUpv4ru+gtljF5cq0UfGkddYadJBa9qH5nTqNu$*6Eyt0)uW)o4o zI;X)D{>#dI8(%wELz1GF@W7BU?iTh#pd^;0(7A|qgmkyuW5DgLce~io- ziyf8;ON`-an0(auAd<+A^E&OM70amakbMh9ou51y1A4-pKz;ftECew{C|lR<2EG2V zc_YNUU-=dDwpU#60DATW|2Y$&LhL{Md zgU?Q#<3)i(y#qZ1bzpAfA$a(p99$lv#>L?Q)GTy zvV36GhERupL#v>^msU5ZmKGe6Pb0Y50Z_*r_EQ}YYljZ+66G=_SknIB zZ29q((LiBZotu{WaHM14bGk|AaDkw7pRRF+J)Lu6k|cfbwnXs?-X|W_s!|@*zFqbI zKH(l_gt(*O6YGy(ey6N?m_zU{`f$GyG}a%6%QeTyYV_*9CTC!O*p|m9#!SnxQYjCr zx0?Pz4pbv$bbm($)?Vpu@0tzWHsS2>)v#t> z@)vmMMS@d6sl1*mp^|5P{sVa2Ydr|^bT4x;;m;G%!7jv|MnM$?)5Ax-e8U)PJP1|j zw%heI;oCzyygq;2y=EfJqsY192X~vsQkXUXIO-m*UbQ!I#`v`?SW-Wg`74otU4C1v*?+r{tKmsUFh+cJOFn%ei*x1dOd6 zFdTHO)IfMfuFw1>5}qFUpQ-y^y)mXc>I%0whfG<;p=IXi5i)%>S(gUE5DNjBWKBzr z_#Wcq8RL0%$M(|1pAfjAhgbM^y%{*VI1Cxpv0wt>7i8%;SsQ+%*i3Mo@%ohOIdc9n_pG$ewjs26kJ$SwQbo^Sk8@-{F@9Fe^jtAAGY004(QP$Jw zW%MMJ!r8%+p2x)wEYW>%pS&FodEgu=HP#p6`0Pp&o4ydp&i>(Z~^F0082|Xag}ZxCR2>ZQ5t; z>A|WQnDS?znrt%Ye7if=pzl|H131>3+~^IjMyPz5ZIm@Fg=5~D$N*x02W!5TwV`kb z5cs|uy{8RXJNs9M*y;%C*|n%;`^I*cHg&PuVYA{FO+N1V#OU2-1R1gU@ug@Xa?q>b ze*(Sl%OV@%(h7UJ-Bu0-x!o!4QqeLO#F)tNvHiyS;USp!I+M=xg@Z(rv47_0_;K4l zshut-0EL`c=&=BxhuXPiRDTm2%{M?W6#9@tfK~EMaZ8WoQZWLcVe@du#-RsW4+z}g zO%&Y$Psw`fY1m|z2k?BkJbNCMBPap;?iM?k=FSWB*Y9pWRVL?x;LPus(N-8_gAb^2 zM!(Sv0At)38Cm$o>ww`vVSsgov{ zCdYVS8Njokqj9l98H3CsY7CH3qo`^|-M;Kkwb$*2&=wdc*1-MVk+~=0au2!?|GVoi zlb*^0KS?Cd6dOGkZxX~LQMUMnNLwVqKjApVqAuG@J2V4|Fd>bG08(u4#?aCTUfwsl z{TWl42|bHA2xHp6o%d%^K-JUV6R+VEJtB_j^juRPb}G3*dpx1g1>G$4D|Q=s2G}3F z;M%u%O4iu*46HuCLsus<$^K?YHU&?^`|2hfnKp0+1Y(JBc(8|T9J{KMB=@c(b3ro2 zd}F1=?F9afZ~ia~4`SjA>gbccd%Z9QB@zWr+A5TT>sE|}xp#hA#&LC`+{fA1q~Mmx z+3>dUL=K{Nck=f3=8SQ@%l>15p%Xoytnks;MkrQJ`6T31H;fuO#pNAfE-KSZmMP3@ zdV?m2M1M4Ni5x`?cm$`5?d(F2Rn)Mc246oiYT~1vAZvcRa4>RjEnY z8NB%znB~)cz7NJ}j%6vQisQW~_;r>G41dCv^mugKaMV#j1*e|WaXQam%?@nx(d*kR z@V)Bo;iEq2(L+y3>yNCS^$`W~tUB=5o*d2ik0YLVGl&)hCY;~+g$9;+2nOIL&ClSa zTuN#y(f|?&^pdT#|Ez4cA^jTq_=Y?0|BCwVa5kW}eTrH&O080>)LunxYP43(*4|X@ zy@`aP_O8aBMb+LrYL6iH9yKCnjTi~R=Y7B5`2U<|Ki74x^W5h?g}(n)O**8@D0X7% zVv1o98ti#psHl7+4G@z!_b)r-6_a96mysLGA`sTw(Ba-7OH=r)+EA&MQ`L_4tX0x^ zh97RKX4$v-B12RoBIkh@0H=2|>nW{0opXR%ix!QX23G=kLL=*dp`Khm?uTVT%=5qU zl4gELxb+XDu+fPBS<+5c=0N?{hS8o(nA9d9b3JdK`8G~5DcxJQ00$!y=d99=`xY)w zp-=NHMv)Qjt9j(z87hEilFo(355}q1@Z61JoxzK+smK_6!asIS7%bE2S{&+M-m`xqaH!!UdGuQ{MHaAnI2l0j<#hiPzCyfQYWoGe0;pPvFm9 zT-J;f{>>*8e=-gaW$IrStoFN!%a~L;Qa~w)fv1KAARO8J#5#Sm8Z{j z#VBuH3O4+H@pkC~JCMTsw_Q%vgPKQz$H#I*U>;hwTpuL-h7cqpS2-lF(*F7RD~i67 zB&2SfG7B>msr15LAdW>s7Alqm5I~DQGk<7+a$^#JgrrLh9s~7$Xle9d(Mgo*vsD77 z{XEUQAQbTUUiSPIpf#1~#b0Qe-(P5Lc5fhIUulw)PBL~)2q*Ap5kw1*lb26_XnqN}@H)z34&U z?4Hgp4HD1g^PpCA;OR=)fDO?6y6cAq?_jC(#}EdCh`QU>IwX)KN;^qF`M~?}m)5JT zP`Yj~INK=K`7hKcie~x|80v(_XO498{ z%^s9ZU(A!qoHI=zrty!fwL9+QM|?owwFzMRf6~AS2FK|Vrouv>ZbLV&|7K8fNZY)u z_sZaM(dD5>N()A^cp|44v_qzt)7Vu!$_hUiHdi!+Gsi3aMT~4UHg=v|7Nr$)@50{9 z>sQQ{(kob4m;|9pD;r0~k%Nr~Vsm~KY04(B>;tCiYDmM}oAtAst`I3MB8-^1o2*4y zg=}#5@v$pYJIkkeVAjPefCS@EAtJ8tvw2n~bX5N#2M1`#1Ca#)q+jL=(#NqNRit|l zV;QlZ#8SMO5qsok2-sFZGbtrhPJ{>uIw=e`rw!G+gd*hp>*aCy>? zvFOe+_1UcHYR?BD$%7t)pjqZN4t<aVv#X#4^luROO`zvzKdla_cXG4rX=K-zCu|J>K`0jQkZn&>rh- z>q*zkKe)=0ROa|p#N4B4M6USBET+lU%s<_26PUl6swgZeP}E@(*;cNu1~k7XyBjLZ z`HpJ}_F3G%AAjI!fpx$zz!qTGfrip=ZgX!>06=%A<7x8awY>DVcI!75wXO&#Uzb9A zHpP!eJ}**?zDle*Ov-CgAC3N^=C%f#m_;69M2Pse-+jVicE?|p7pHyz$4(J<~(i=wYOGLEU<%oiQ19w`jb~5lv3X_mQZu-QAF5j zyURDVYTRjBr8W-84N##WY~6PKt5@Up{EN%>@?_At1##d*91dmXm79_9O;V`0J-&J- zpK)+*(;)3(T5-M#g*qaET^f{}zKnLz!3M-K{r>y{M~!|6dK$UU0{mKS1)jh089wp^ zYd{j+YOQw%d+yQ?e0FVr=dgLi!3zTw+BkM`_el7$gU;YJ$1KNg&gTayx7TlO%4d!M zt?uykNvryn@^{l4w$F`sbSjz%J*O15cln`|JisON88##nfPU9$(VI2@VJ)y4#^{%M z6js!13fnZP*!`ln;HMR^%EyNq@W#*DCvh1TYB6&#vZSlKwm19H~JQ6?WU;JO# z5kR7Ld^&MB&Ca1I>0t!MCA?GexWe&E#x3p=}c>M%Vwn0Sj)w5+(Zh1v781%P3 z*?dm@r{9L5rIzX@KJW$=;>v3tbcad25&#QagCiBE75^)48;W>{K&Dj_?+f*XXBZ!F zR_V>eQ`v_Q#P&x7ry?n1VXlqKT`eXnzX*Ztign-ZO&3fsm%QACV)MCjOiNwT=Rf@? zyE>F^p~Y9X(2UW~pQF3J5l>#Y@4~0|SZ<;CC`X;(%hUO7L*CnkziIFKcH-Xvw5TOh z`hM3OpEVQYrK*@}CPu^F?*}utYCbXE)Y)67QZjfd%Vop$A`N=Hdo30DIIr^(gHF1G zvq(BMeUX^Ne34-3H7~e>%PNPbHFdm}aWQ!^X#P(YL}d5S-T0_|l4n;p!5Gm?U+7fP z!jB{4W`p$yzKYNU-Cx{?4&c<=Xpg`J$C=E?Pll3-8jyKO;5-)-tLhVDbw&n{oQEfp zof$G!Uf&fSJbY-BLUn8LXFT7c=|_TU%MEA`XW4~ncv(2+JJ8ZUq^W_ev5BP!uL%Av z=w6fluf(qR<`3BpQd!vW)pW8Y%HvP2CAg_7n2!jK^-iTP%`tGDw?^{a6(7LAxz1Rv z3)Vtc$M>Et-r$@L&XwlS{{#* z%?2{~t{;8&ntME~&j1RJ1vVdO;f_^L8v1izz0`GA82%;8E0G;Q!Jbk=Rk*Q9ykP{9 zwvb)l!HhkuHYv7Ct~*nRc}1w4!c$`~1^wOja3=&Y)f{t1-=17-oH(8FS!4=SyXujR zcIH(75Xghz3@T(Jzoi37k;X zrbjpVDeqg4O?>>{{~ew0*i0`}sgF>o_H#p@!M32sD=a(I5fiV}V0=RFX)h@kwli7; z{v~k=mD0CJ@X^Ot(aifPRR8Z|g=rE&)N^HKn|fz(F`b91J~!2` zpdH(30GLb5bz4^RmU)Qg7O?xh9x>9j);4v{eWiVeBtoCjmo1|`ldGQ<_GkYnREV0? zsed4$`tejon3!}p!kRPMC4qh3`uXcD?cG!Wnq;f%-WdXr5n&=$7Hf3o7kgRFmrzTP za(2#kiBiBUD&q6^jT@>qc~U25YJpM&x~wo)d1K&e6S9=jH+B`JWUvQAqO;(17FZBK zcx^2vQ;a>m^3e;)2OBOjk*fw3<-QOGF4nJh-Fe7D@)QHwu-olV&mk**>sJ#6D_-mi z1iuSrns!P{xpKoTmeFUY_g+8@<#l$B09pU8vjyc5#dh9+T8)M76ckFg{#yX@SDV~_ z(eN_~_V>2%zB;6U?-2mK>NM_WQG4enWns>yR_=e-!J)2Xsl~^w{mOUq`;0#r6oN5}O5)y#~?c?S*h_@upl zQSy^#c-Szn|MpDkzu#dd+?fu+QO0NO2y=9U~R?6EJ(#tAM3y9Y}Pi`s}tCNwwa2 zq;(h27Sf=*EPTSC>bujBTN7ViPPcB#Ecj15jlExHvqY+ehUaeG>K1x~-ZQ!Nl=-kn zbP)|!kLykq(9nektRqYaa2aJ4Y+HX~@SiSv>0jRh`im5=!Js~^^?mSxJKTMHjY?v8 zVIE67<#Il@C2JLsypu8oPFN?4$Q&t=oadNY1q>5`q0I*^QX6R zD4HPWPxKb^tRKjS|8J1^U8ka6>G!fSg0%b(KS1{x<2i#afYzM<)w5L?N~eI>r8^bS zwB=5inr;qxZGSPSOpxdJUgs4XN6ekD1eco*;qL{MrcO!6N!%)#{81Sf_ZdZ0`s`&5J~>IzYFU(_%TMg&eCB69q)8it?8MkVAL;BV zxo%KgVZB&PE1{6*vo?tl;p6&BEidXAq~a!gR4^!UgbY4PvXoo}g@|oO-m(Et2NS!F zkxPjdsj0BVqIu_(Px80y`06F@sNN1iwwb6x_Vg18aeQURHJ&uTdSTCpvrO)&fEYq6 z3kicA_FqElr+57>tMvTaU`FZ;BtE3n-*3WeS*+rcB3msBs|q#%!*V=^&TH|tO#lug zbPPScgFy-h)yjm{HnbHr;gvzdYz}3F9Hr66nP~TxkIrmX8^Z`nJ)!Zys*x~i5yyiA zFG+l@ZEzN{bPSEKyJWqYPfKh0%D~e4Nnf9$+>x0>>jaPv0B}yxMjKK9dN#INB!6n$ z#~M#K9cC)sbjALErQN{AgfN~}r#G-nd^BSA!%)DPSJ#9DdyI8_|DY6uymG~$2jpi$ zQ>-1y;*M|Wxt4FZ0VYXZ%}P5%g)eAZQA2i3lr@%Rh9>Gi;cZ+?2|6M>ll z>J}}1wB{2?<>u6mTRIXu8b_BX{J-6><*dVT$eTBT8J{L&!+3C;BD1rvuYuhHF;8{8 zQ)^BjmNlgbTkeqPm6b2sPbI>@NHly0`qJ%m4~6m$k2 zIZ(#DZ)glNu@M>{^c+DeTglVV*KE3 zz`=sp7EzVg64RmB#$|Cuymg-H0)A)kf%y1%`aw98n5=6hg=p&P? z9q7RG#bI#wICqbtjv;#y(GF+nK1a}HbB-7tdu9GF$2Pgu_4T~DPkel(q8XK3CJq(1 zAC&RiyOk-5UhcMTr#5%4ji@2Unq*H7_EX#ugj1x}^sm_IViJ>6VtXUE;R+luu`SxS zid2!9y_hO<`fuf*arD<-?Ha_lOOseuPzM8$bU4?A*sC9cZMMek1n--73oL!8@)pjyO^GmWJ17DxbFwwZ?>PB5AxD)L!t0M6y6OJ=5Dsw^k3~)39Ki*1MN7*Gu^uS zcn2ap+}(4ZHAsif2>)KEH>p06lgOv6=0G_2N5}_XW_dM9l$k0lJwQQXB6!9yMal|@ zbXo@n?{+f2J1Zi(fb&EZvlPlPkN^fu8K=Oj}FISvK!kkR6w62xmiS0Lm;_ZMs)w*hs^uk@r zi!K5FkcuzOzxd}}b#6y?Y{2IK?54LDxNG%A1Hq!38nzu+3^^G z<9OWrZhVDE;@Z)L7>Oi}<6d6_9`57qhu@MG<&LdMm}#<#QEi@u&Rwx*`77q-=GEcA z5F^+3wRv~92WIm^XWqu4T34W-bOy5BHI>DC-7&le9XJIc-9a6loj73@iXV;nNy(qJ z_}?B;Rr^s#lI0NVq)>6Gt&Yoi$uQ7-F1?^sOvJTP^G;16O92yqCD%ml3T*6hMT^cD zRhluHrmM&l%HA}1HO(I6d}*G`{Da!T;rmwPC#YHqvN=t^<_i>b>q;Ga&Zq?e7X9hi z^?Kf3tyT`bv}nw;|Liab90mNtt3>fU=4x!t!~U%^>pt;8zx2nV9QVoSvRJMyNuDV4 zv5Vj@Ls|1FBE98xkWy@yx@M=zr+cT&=69&P=^Oe9ecMjl?YCGkkH3tAX6!->L<26a z-Kg!x>&h_wj#OmYG;#eU#N4-U&PK*y#A8;EmkrSyt!&*P^jcaJE-URVhK(k7!I#}7 zc=cQy|EzTJo#&*)%~(VeI)E)Fhz_~56ulIyB(s=2bG$Zhg}O%hcQ48ZpVFc$ty_g! z4u*znqi}Gr_df07jntKq-7VeVMQ z)(4M;)lp~vVqfa%Obd9n-rQ>an>tT`U`AzYOGZSDWm!PYkg=p9;0|orKEhTn=sgt0 zhEQj=P+%$H{P0mS#W^G^8rz;o_v)Z*!`XJw>E^K0rOCb_mN4MOJoyKdyMC7uIc9qs zcSVNQ;d+48Hzg}l)fE*^wjps=YV?!StX^Q@=F8I-e<4F+{+B)Oc60S=0(*9F(Hart!5pnRV_aE_nI zmVuGYkmwOX`_Pu(_Iy=PLlpa;@!Cpv8tCA_a?yVJ`_lSP840FezVboo0}!P7RvJ_R z%{uS@n$mvYl=vgv5%DPIfOfiRRw~*9b@9XND9E9zK|!HOJx+0-$jkGj_(bsap={g} zQgi#dC#hM3c>CmNhb(dN^QiHh$UML0pU2DRz+b5=D+ zsWOWdnM5vx4IeU1IiE;bL5t6G0A|xb+X}sS=8pMK%zk{f4%bmba?HMRt}ek7-rEj< z#fvb0@~Yr8mUaE@v77VUg8ua)b|$=-eH(N0^zd8^ZAeN-cw2_QKw=y(qF13Q6{n|f z|M!)oB>&Kr5_DKHr=^+*rB_gt7sZaMNyJ}&uajMfm8{TL@{0JBCfq;$D#C+yezLb; zd|T_|=f&VkKRy^BFvXaF=-a-5{Z`eS_5AaebP?Q=PG&*LD`(%8Pp%pH^}ee7-`+;_ zFL-A9o*_P$zCSMt-D2j$k$5#MG<@eFcOUf4^oNC|Q?dlH2houFlWYcmg=05|%bh7? zeM~}MtKI5_4Fr&Wj2)r15)|}*x_nSwq*UyI@@N`xST2oVpT5N!XHi{}D^t3LW z)QWYzln?}cv`F-@tpJ-bx;2s|w(^WsB^_*bQKh+#fV_AwFOu0j+L zhwf}0{96B>DmmoSin7%d_O_O{J?}3_-K{!xpZ7NQ_1O(piGa>BCsb~N8fz(%;B5`S z><96Y71j{(#eq3vk|K+edR73!{2M5dH}c1Qy|cIIhJzvK@RXPKN|HlJ7Jc}YZ)x@R z=6GiB+z>kK;_-@eC`_D*ELPO!BWtwUb{4TlSlBi^{-ZU3lRqhQOT4Oj1Jq$=W>0VM z+{dD6A_66!;&N;G?v>?NJnBa*+$P)Xf=(NM%N(uPBV1I>u+xMQdzMejPXd3a z9q)SU?37-g=>@v+(O*b`k6cy3-Gpik&WnP&pu)H1!R2pc?@srJhOS1qYmqM9$E}w4 z(b&5mLotm9<t93*u}%_?&I@<({Y~xI@y}YYbBk;1;BMyD z;^O|%)9HzryP2v{H^`S(=iy}m#Zv?v-Rx5NHb-kYv%5T}@YGaUER3yRC;>xehpD!es1gMDY)rLAZ4`DY_hw!C7jR>u(TKM-eB8GtSm3a zstZT$5maSzy-rWzwtu?^K)ymZW95bGe{|MtH1A7e^2Jj zh&aEAV%iw0dSO6u2A+JGRA_OB+bc^SPqbZ!3Txk_Z=2>rQN z=Vock1nN#SB$^R)M-Sle9ulB-9$_v3b(duYR-=9@OfkQ`+}vu!_ReUIg6erUr9` z7^=Hgn6q0LrwQ1a{$~BSfVntOrqCTWDg;%v-waLrPIGb1|1^KhHvi0K29+EG$LGB| zUTFD@uEmy}4Gw1v9*w+?J$S?KW>^EXx)N2+TC zhONu}Nda!+B~dT04W+#&CLTBJcxA6 zPcr?5?VaFqQp3@hM6^I-40PiJ{kS5$gGlOXz$JK?u_l-{sk z^&S$X))sE=9Q3;%q{FW@Czd1#hf#5VtC(ppQgOw7E`vkrTc^}|fQ-3!v_JhmiKM|HrA2=Bl&?)2e)`;lG^#ZViDV4_R$p6~Js? ztK4U6+^#q|xg*yn)6VP}v(xi9#8;AAr`&=Zn~=W#0?9ANmZ)LzXh=a~C+wtPXUDyM z6h@*TXZ5@<{^5>Hy!mSll$Etg)A9XMn_4$PVj>{!fBQm>(Uu>GWFg-A1U3%q- zIW{nU5#n6K@#^b}C`pGruWVi~g0^OSuGJqe-QckH;(U>ljsE?j&C@rLrKlj?dw~zF zSm$QbZSRUF!86E4BvL`}S%M4Jt+2-qE~L|xS~P;Wva@JQTSLutv&NZLtoo~^Vt0tb zmjFzeDM|3wz>BmVNP=3eCmeQOYTx*7sZ1kyw%Bu;z85%+ zq@9l@iwHik5aU-k`WKtEIk@&K@n2U<)!}T5MvHm-%|$QF;vQ0)G6^N?rpU-HIrwZR z;|I7qQ_QvKy}ZrK1%N&Zke^v|DL2$UYEX<&c;LkykuJR<52H7suV3J^j*J6JKh0PN z#Oy6qY&&6Fk5bo94sA$KmQvJsD9MwS`}qFif2tL-SS$0dpI?Zc(v;*oAHxCD4|MA- z4F(8{p5fONvZqT8@lF=nGL{2+4*D_s$B(k5}$UmeZ7|j zD(=(@Hiu`Ke7^e^)z#Ito@z{&pknX+4Hje$XR;()V40J6`k3|ScoU!Pabun5@9%mP zmE0H)8ujqF3@j`{ssH>D@QaMH5^8TCZ^LDO{!!%PNEn6MW7YyC+i#)^Ow8An7w4hu zJ@(nP%+vtDo!CBc0r?3jw%d0#ygUU24b7gQ#AL4HJ^wT?jFCKsgZ06I)s3?0qQi$N zB1!(9M3$G;5+Nl%L^iTl=&#ok5~E5*pOeBWrLW$koe8@$Zw6)W)1O4YY46?P5(SAV zQT%^;4ds0^Zq*?DWKH2F&`MIl^ zWEn%ensMHAjJ3`FI1qZl*{@K`N&MXJDJ!0e+qa*e+GM{4^Tk)bR+MV8-stG&VK7`i zKAqZPTO9O+%>d^;IPwo^(&- z+FY-X4}F7=lL%`%MHaXyLv>oz)~+?>bxYyv?uV!4Q$xcnTb0^<-wehR<%%U;Jo>Og9FXpA z7+m9CzO^|~+=lCrvnjn1kK-e#&g&3sd&NfXGTJ0kul{Ll{gzl81UqJ8_%IE*41!RmC`9Gbpt%HjA}7%@P?8(&foUCm1E*2&oP zA?!^}75N2RqeGh;addDgdKQg0I&z5<894GRqif|!!3NMzWJqa_F-WrD_LYmrp1Hn| z-7Lagf`8mNvVumy?6;R;ff`k9|FlT-ilx{F(5Q|&)E(*xCmJ>xaZjpw`2yF}9d;*_1R z_t7&i=K$3fV-{5>8-EF-Ja#@rS&T{rkI-8f{%WI`b)?cK3Er*wIuc1Bfos##&3)2p zP)wC7<6gKp`E7wy8J?h-et+SU-WxMo1qIc0l;u17=TaMHv%A&z!NcLz_iUq}^ALcRQGp zO3#doE5|#DE|A17N&RrT%=+<_Q}UAjR}>vMemq*pZZSq4keZc7wkj?Tyw0KDeUqAX zGZq}z9c5m3xA==aFv2W4<~sN*{{4?ULGuufMXW;sxyI+iSm?i7hO@%9UYV(+`Q>Nos%vF8g!Usd2P z;4~-_8`!v6@(tpz_4Q(RM26{pkU|)UyNr=ihw-ukPHw<UpU+AXw!RaEXpRZ`!! zYg8dc?5IoMJQ2hB>hz-+?AEJm77QYbCtHtF_p0^ms1x@`UMtAF;}i{5AxiVl9DDpj zl)*5)Ng<4^TDD4i$KlbhQ-E&f_bUF+KzD6OX^sBayL(UNNV{|$loE2{yD|2UlLV?J z@Ig(y`w&7yeCv-`?uUV^&4RXrHsy&k@i}adNm;XgZ!a@xnvjG)yI_LjRiUqV%gYIh zTK1D&S;x6J%jL!y86wNhlMbcxK=q;CDA?OTEGBAUdVZ$JYB=ElyA%2HUEC_MuhHw9 zfP)~1CR0x8cHDC6+A8>NSYxQ2z$vA2UJn>pzZdq@C^#Xoh zdqe|=^fm{HmPOP#EjbbH25nT$CZP%K7azkF(mG$3cnFnvV!sc|V%0fVJ$l8KpsRTu zO8L$dH*_-Z+K;9`{p&$Rca2+turcwk=8~cyK0rNk55^Im*gM#q=U-^i{<0)$3uHRn zH_J=aK6A*?VLE!3Hi&0;r$KN%3v1#-jxKH%pl+cXKmYXX5gm8@@y1#xCav0t9od(z z48bdZip}mIsrXig{8+&@W$YEwRGTr);Lw|2E0DvqPPPlK%Q*y-eRpGMtZQa*dHiOB zm&!{b3*PxxlCIhz1he8Qe_ituN*=VlqosmzZgl~c62oxde$5Fm7!q248t=D%7jc(T&EAIMN0uPq5-R!nvG8HJu)x# z2l7Bbq!k*ScO@_{>}1p$JUt%!O}$q309mlnN$TVTn`5E)<0cDkchxB5N9ij>^1C4R z#OSfF27Mj!AhRy0lnNE`7ddO(RS@~@s9$AV72Rat8_}SIGlyS`bO`b4OLVX-@+it2;l!x9Kc))(Q=DJL~4JFw^ z(QdVI!ny}MfWXZX+W7j09)ZfAZ3qAKqN*1(7zzgC2SM1%t1q&GJt^ZKz5~NjeW$5Z JrC|B>e*nH7H{}2T diff --git a/website/docs/tutorial-extras/manage-docs-versions.md b/website/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index ccda0b9076b..00000000000 --- a/website/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/website/docs/tutorial-extras/translate-your-site.md b/website/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index b5a644abdf9..00000000000 --- a/website/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -export default { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 04de875a844..57ec2885f96 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -2,48 +2,39 @@ import { themes as prismThemes } from 'prism-react-renderer'; import type { Config } from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; -// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) - const config: Config = { title: 'Kubernetes JavaScript Client', tagline: 'JavaScript client for Kubernetes', favicon: 'img/favicon.ico', - // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future future: { - v4: true, // Improve compatibility with the upcoming Docusaurus v4 + v4: true, }, - // Set the production url of your site here url: 'https://kubernetes-client.github.io', - // Set the // pathname under which your site is served - // For GitHub pages deployment, it is often '//' baseUrl: '/javascript/', - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: 'kubernetes-client', // Usually your GitHub org/user name. - projectName: 'javascript', // Usually your repo name. + organizationName: 'kubernetes-client', + projectName: 'javascript', onBrokenLinks: 'throw', onBrokenAnchors: 'throw', - // Even if you don't use internationalization, you can use this field to set - // useful metadata like html lang. For example, if your site is Chinese, you - // may want to replace "en" with "zh-Hans". i18n: { defaultLocale: 'en', locales: ['en'], }, + markdown: { + format: 'detect', + }, + presets: [ [ 'classic', { docs: { sidebarPath: './sidebars.ts', - // Please change this to your repo. - // Remove this to remove the "edit this page" links. editUrl: 'https://github.com/kubernetes-client/javascript/tree/main/website/', }, blog: false, @@ -54,8 +45,61 @@ const config: Config = { ], ], + plugins: [ + [ + 'docusaurus-plugin-typedoc', + { + id: 'sdk-api', + entryPoints: [ + '../src/config.ts', + '../src/config_types.ts', + '../src/watch.ts', + '../src/informer.ts', + '../src/cache.ts', + '../src/exec.ts', + '../src/attach.ts', + '../src/portforward.ts', + '../src/cp.ts', + '../src/log.ts', + '../src/metrics.ts', + '../src/top.ts', + '../src/object.ts', + '../src/patch.ts', + '../src/health.ts', + '../src/middleware.ts', + '../src/types.ts', + '../src/yaml.ts', + ], + entryPointStrategy: 'expand', + tsconfig: './tsconfig.docs.json', + out: 'docs/sdk', + sidebar: { autoConfiguration: true }, + readme: 'none', + excludeExternals: true, + excludePrivate: true, + excludeProtected: true, + skipErrorChecking: true, + }, + ], + ], + + themes: [ + [ + require.resolve('@easyops-cn/docusaurus-search-local'), + { + hashed: true, + language: ['en'], + indexDocs: true, + indexBlog: false, + indexPages: false, + highlightSearchTermsOnTargetPage: true, + searchResultLimits: 10, + searchResultContextMaxLength: 50, + }, + ], + ], + themeConfig: { - // Replace with your project's social card image: 'img/docusaurus-social-card.jpg', colorMode: { respectPrefersColorScheme: true, @@ -69,7 +113,7 @@ const config: Config = { items: [ { type: 'docSidebar', - sidebarId: 'tutorialSidebar', + sidebarId: 'docs', position: 'left', label: 'Docs', }, diff --git a/website/package-lock.json b/website/package-lock.json index 70d8905de5f..beec061359d 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -10,6 +10,7 @@ "dependencies": { "@docusaurus/core": "3.9.2", "@docusaurus/preset-classic": "3.9.2", + "@easyops-cn/docusaurus-search-local": "^0.55.1", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", @@ -20,6 +21,9 @@ "@docusaurus/module-type-aliases": "3.9.2", "@docusaurus/tsconfig": "3.9.2", "@docusaurus/types": "3.9.2", + "docusaurus-plugin-typedoc": "^1.4.2", + "typedoc": "^0.28.18", + "typedoc-plugin-markdown": "^4.11.0", "typescript": "~5.6.2" }, "engines": { @@ -4063,6 +4067,170 @@ "node": ">=20.0" } }, + "node_modules/@easyops-cn/autocomplete.js": { + "version": "0.38.1", + "resolved": "https://registry.npmjs.org/@easyops-cn/autocomplete.js/-/autocomplete.js-0.38.1.tgz", + "integrity": "sha512-drg76jS6syilOUmVNkyo1c7ZEBPcPuK+aJA7AksM5ZIIbV57DMHCywiCr+uHyv8BE5jUTU98j/H7gVrkHrWW3Q==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "immediate": "^3.2.3" + } + }, + "node_modules/@easyops-cn/docusaurus-search-local": { + "version": "0.55.1", + "resolved": "https://registry.npmjs.org/@easyops-cn/docusaurus-search-local/-/docusaurus-search-local-0.55.1.tgz", + "integrity": "sha512-jmBKj1J+tajqNrCvECwKCQYTWwHVZDGApy8lLOYEPe+Dm0/f3Ccdw8BP5/OHNpltr7WDNY2roQXn+TWn2f1kig==", + "license": "MIT", + "dependencies": { + "@docusaurus/plugin-content-docs": "^2 || ^3", + "@docusaurus/theme-translations": "^2 || ^3", + "@docusaurus/utils": "^2 || ^3", + "@docusaurus/utils-common": "^2 || ^3", + "@docusaurus/utils-validation": "^2 || ^3", + "@easyops-cn/autocomplete.js": "^0.38.1", + "@node-rs/jieba": "^1.6.0", + "cheerio": "^1.0.0", + "clsx": "^2.1.1", + "comlink": "^4.4.2", + "debug": "^4.2.0", + "fs-extra": "^10.0.0", + "klaw-sync": "^6.0.0", + "lunr": "^2.3.9", + "lunr-languages": "^1.4.0", + "mark.js": "^8.11.1", + "tslib": "^2.4.0" + }, + "engines": { + "node": ">=12" + }, + "peerDependencies": { + "@docusaurus/theme-common": "^2 || ^3", + "open-ask-ai": "^0.7.3", + "react": "^16.14.0 || ^17 || ^18 || ^19", + "react-dom": "^16.14.0 || 17 || ^18 || ^19" + }, + "peerDependenciesMeta": { + "open-ask-ai": { + "optional": true + } + } + }, + "node_modules/@easyops-cn/docusaurus-search-local/node_modules/cheerio": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.2.0.tgz", + "integrity": "sha512-WDrybc/gKFpTYQutKIK6UvfcuxijIZfMfXaYm8NMsPQxSYvf+13fXUJ4rztGGbJcBQ/GF55gvrZ0Bc0bj/mqvg==", + "license": "MIT", + "dependencies": { + "cheerio-select": "^2.1.0", + "dom-serializer": "^2.0.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.2", + "encoding-sniffer": "^0.2.1", + "htmlparser2": "^10.1.0", + "parse5": "^7.3.0", + "parse5-htmlparser2-tree-adapter": "^7.1.0", + "parse5-parser-stream": "^7.1.2", + "undici": "^7.19.0", + "whatwg-mimetype": "^4.0.0" + }, + "engines": { + "node": ">=20.18.1" + }, + "funding": { + "url": "https://github.com/cheeriojs/cheerio?sponsor=1" + } + }, + "node_modules/@easyops-cn/docusaurus-search-local/node_modules/entities": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz", + "integrity": "sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/@easyops-cn/docusaurus-search-local/node_modules/fs-extra": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", + "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@easyops-cn/docusaurus-search-local/node_modules/htmlparser2": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.1.0.tgz", + "integrity": "sha512-VTZkM9GWRAtEpveh7MSF6SjjrpNVNNVJfFup7xTY3UpFtm67foy9HDVXneLtFVt4pMz5kZtgNcvCniNFb1hlEQ==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.2", + "entities": "^7.0.1" + } + }, + "node_modules/@emnapi/core": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.9.1.tgz", + "integrity": "sha512-mukuNALVsoix/w1BJwFzwXBN/dHeejQtuVzcDsfOEsdpCumXb/E9j8w11h5S54tT1xhifGfbbSm/ICrObRb3KA==", + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/wasi-threads": "1.2.0", + "tslib": "^2.4.0" + } + }, + "node_modules/@emnapi/runtime": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.9.1.tgz", + "integrity": "sha512-VYi5+ZVLhpgK4hQ0TAjiQiZ6ol0oe4mBx7mVv7IflsiEp0OWoVsp/+f9Vc1hOhE0TtkORVrI1GvzyreqpgWtkA==", + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@emnapi/wasi-threads": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.2.0.tgz", + "integrity": "sha512-N10dEJNSsUx41Z6pZsXU8FjPjpBEplgH24sfkmITrBED1/U2Esum9F3lfLrMjKHHjmi557zQn7kR9R+XWXu5Rg==", + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@gerrit0/mini-shiki": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.23.0.tgz", + "integrity": "sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-oniguruma": "^3.23.0", + "@shikijs/langs": "^3.23.0", + "@shikijs/themes": "^3.23.0", + "@shikijs/types": "^3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, "node_modules/@hapi/hoek": { "version": "9.3.0", "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", @@ -4631,6 +4799,18 @@ "react": ">=16" } }, + "node_modules/@napi-rs/wasm-runtime": { + "version": "0.2.12", + "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-0.2.12.tgz", + "integrity": "sha512-ZVWUcfwY4E/yPitQJl481FjFo3K22D6qF0DuFH6Y/nbnE11GY5uguDxZMGXPQ8WQ0128MXQD7TnfHyK4oWoIJQ==", + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/core": "^1.4.3", + "@emnapi/runtime": "^1.4.3", + "@tybys/wasm-util": "^0.10.0" + } + }, "node_modules/@noble/hashes": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/@noble/hashes/-/hashes-1.4.0.tgz", @@ -4643,6 +4823,259 @@ "url": "https://paulmillr.com/funding/" } }, + "node_modules/@node-rs/jieba": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba/-/jieba-1.10.4.tgz", + "integrity": "sha512-GvDgi8MnBiyWd6tksojej8anIx18244NmIOc1ovEw8WKNUejcccLfyu8vj66LWSuoZuKILVtNsOy4jvg3aoxIw==", + "license": "MIT", + "engines": { + "node": ">= 10" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/Brooooooklyn" + }, + "optionalDependencies": { + "@node-rs/jieba-android-arm-eabi": "1.10.4", + "@node-rs/jieba-android-arm64": "1.10.4", + "@node-rs/jieba-darwin-arm64": "1.10.4", + "@node-rs/jieba-darwin-x64": "1.10.4", + "@node-rs/jieba-freebsd-x64": "1.10.4", + "@node-rs/jieba-linux-arm-gnueabihf": "1.10.4", + "@node-rs/jieba-linux-arm64-gnu": "1.10.4", + "@node-rs/jieba-linux-arm64-musl": "1.10.4", + "@node-rs/jieba-linux-x64-gnu": "1.10.4", + "@node-rs/jieba-linux-x64-musl": "1.10.4", + "@node-rs/jieba-wasm32-wasi": "1.10.4", + "@node-rs/jieba-win32-arm64-msvc": "1.10.4", + "@node-rs/jieba-win32-ia32-msvc": "1.10.4", + "@node-rs/jieba-win32-x64-msvc": "1.10.4" + } + }, + "node_modules/@node-rs/jieba-android-arm-eabi": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-android-arm-eabi/-/jieba-android-arm-eabi-1.10.4.tgz", + "integrity": "sha512-MhyvW5N3Fwcp385d0rxbCWH42kqDBatQTyP8XbnYbju2+0BO/eTeCCLYj7Agws4pwxn2LtdldXRSKavT7WdzNA==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-android-arm64": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-android-arm64/-/jieba-android-arm64-1.10.4.tgz", + "integrity": "sha512-XyDwq5+rQ+Tk55A+FGi6PtJbzf974oqnpyCcCPzwU3QVXJCa2Rr4Lci+fx8oOpU4plT3GuD+chXMYLsXipMgJA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-darwin-arm64": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-darwin-arm64/-/jieba-darwin-arm64-1.10.4.tgz", + "integrity": "sha512-G++RYEJ2jo0rxF9626KUy90wp06TRUjAsvY/BrIzEOX/ingQYV/HjwQzNPRR1P1o32a6/U8RGo7zEBhfdybL6w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-darwin-x64": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-darwin-x64/-/jieba-darwin-x64-1.10.4.tgz", + "integrity": "sha512-MmDNeOb2TXIZCPyWCi2upQnZpPjAxw5ZGEj6R8kNsPXVFALHIKMa6ZZ15LCOkSTsKXVC17j2t4h+hSuyYb6qfQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-freebsd-x64": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-freebsd-x64/-/jieba-freebsd-x64-1.10.4.tgz", + "integrity": "sha512-/x7aVQ8nqUWhpXU92RZqd333cq639i/olNpd9Z5hdlyyV5/B65LLy+Je2B2bfs62PVVm5QXRpeBcZqaHelp/bg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-arm-gnueabihf": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm-gnueabihf/-/jieba-linux-arm-gnueabihf-1.10.4.tgz", + "integrity": "sha512-crd2M35oJBRLkoESs0O6QO3BBbhpv+tqXuKsqhIG94B1d02RVxtRIvSDwO33QurxqSdvN9IeSnVpHbDGkuXm3g==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-arm64-gnu": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm64-gnu/-/jieba-linux-arm64-gnu-1.10.4.tgz", + "integrity": "sha512-omIzNX1psUzPcsdnUhGU6oHeOaTCuCjUgOA/v/DGkvWC1jLcnfXe4vdYbtXMh4XOCuIgS1UCcvZEc8vQLXFbXQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-arm64-musl": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm64-musl/-/jieba-linux-arm64-musl-1.10.4.tgz", + "integrity": "sha512-Y/tiJ1+HeS5nnmLbZOE+66LbsPOHZ/PUckAYVeLlQfpygLEpLYdlh0aPpS5uiaWMjAXYZYdFkpZHhxDmSLpwpw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-x64-gnu": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-x64-gnu/-/jieba-linux-x64-gnu-1.10.4.tgz", + "integrity": "sha512-WZO8ykRJpWGE9MHuZpy1lu3nJluPoeB+fIJJn5CWZ9YTVhNDWoCF4i/7nxz1ntulINYGQ8VVuCU9LD86Mek97g==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-x64-musl": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-x64-musl/-/jieba-linux-x64-musl-1.10.4.tgz", + "integrity": "sha512-uBBD4S1rGKcgCyAk6VCKatEVQb6EDD5I40v/DxODi5CuZVCANi9m5oee/MQbAoaX7RydA2f0OSCE9/tcwXEwUg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-wasm32-wasi": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-wasm32-wasi/-/jieba-wasm32-wasi-1.10.4.tgz", + "integrity": "sha512-Y2umiKHjuIJy0uulNDz9SDYHdfq5Hmy7jY5nORO99B4pySKkcrMjpeVrmWXJLIsEKLJwcCXHxz8tjwU5/uhz0A==", + "cpu": [ + "wasm32" + ], + "license": "MIT", + "optional": true, + "dependencies": { + "@napi-rs/wasm-runtime": "^0.2.3" + }, + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/@node-rs/jieba-win32-arm64-msvc": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-arm64-msvc/-/jieba-win32-arm64-msvc-1.10.4.tgz", + "integrity": "sha512-nwMtViFm4hjqhz1it/juQnxpXgqlGltCuWJ02bw70YUDMDlbyTy3grCJPpQQpueeETcALUnTxda8pZuVrLRcBA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-win32-ia32-msvc": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-ia32-msvc/-/jieba-win32-ia32-msvc-1.10.4.tgz", + "integrity": "sha512-DCAvLx7Z+W4z5oKS+7vUowAJr0uw9JBw8x1Y23Xs/xMA4Em+OOSiaF5/tCJqZUCJ8uC4QeImmgDFiBqGNwxlyA==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-win32-x64-msvc": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-x64-msvc/-/jieba-win32-x64-msvc-1.10.4.tgz", + "integrity": "sha512-+sqemSfS1jjb+Tt7InNbNzrRh1Ua3vProVvC4BZRPg010/leCbGFFiQHpzcPRfpxAXZrzG5Y0YBTsPzN/I4yHQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -4873,6 +5306,55 @@ "integrity": "sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww==", "license": "MIT" }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz", + "integrity": "sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.23.0.tgz", + "integrity": "sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.23.0.tgz", + "integrity": "sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.23.0.tgz", + "integrity": "sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "dev": true, + "license": "MIT" + }, "node_modules/@sideway/address": { "version": "4.1.5", "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz", @@ -5192,6 +5674,16 @@ "node": ">=14.16" } }, + "node_modules/@tybys/wasm-util": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.1.tgz", + "integrity": "sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg==", + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, "node_modules/@types/body-parser": { "version": "1.19.6", "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.6.tgz", @@ -6867,6 +7359,12 @@ "node": ">=10" } }, + "node_modules/comlink": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/comlink/-/comlink-4.4.2.tgz", + "integrity": "sha512-OxGdvBmJuNKSCMO4NTl1L47VRp6xn2wG4F/2hYzB6tiCb709otOxtEYCSvK80PtjODfXXZu8ds+Nw5kVCjqd2g==", + "license": "Apache-2.0" + }, "node_modules/comma-separated-tokens": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", @@ -7895,6 +8393,19 @@ "node": ">=6" } }, + "node_modules/docusaurus-plugin-typedoc": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-typedoc/-/docusaurus-plugin-typedoc-1.4.2.tgz", + "integrity": "sha512-1qerRejLSYxEWdyVPLDMMeKFPLA/37yZAsdwJy9ThHFQR78+v3b5spSbk67VHGLr2mAn4FVHu0aGJ6p7iWotSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "typedoc-docusaurus-theme": "^1.4.0" + }, + "peerDependencies": { + "typedoc-plugin-markdown": ">=4.8.0" + } + }, "node_modules/dom-converter": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", @@ -8071,6 +8582,31 @@ "node": ">= 0.8" } }, + "node_modules/encoding-sniffer": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/encoding-sniffer/-/encoding-sniffer-0.2.1.tgz", + "integrity": "sha512-5gvq20T6vfpekVtqrYQsSCFZ1wEg5+wW0/QaZMWkFr6BqD3NfKs0rLCx4rrVlSWJeZb5NBJgVLswK/w2MWU+Gw==", + "license": "MIT", + "dependencies": { + "iconv-lite": "^0.6.3", + "whatwg-encoding": "^3.1.1" + }, + "funding": { + "url": "https://github.com/fb55/encoding-sniffer?sponsor=1" + } + }, + "node_modules/encoding-sniffer/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/enhanced-resolve": { "version": "5.20.1", "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.20.1.tgz", @@ -9785,6 +10321,12 @@ "node": ">=16.x" } }, + "node_modules/immediate": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/immediate/-/immediate-3.3.0.tgz", + "integrity": "sha512-HR7EVodfFUdQCTIeySw+WDRFJlPcLOJbXfwwZ7Oom6tjsvZ3bOkCDJHehQC3nxJrv7+f9XecwazynjU8e4Vw3Q==", + "license": "MIT" + }, "node_modules/import-fresh": { "version": "3.3.1", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", @@ -10371,6 +10913,15 @@ "node": ">=0.10.0" } }, + "node_modules/klaw-sync": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/klaw-sync/-/klaw-sync-6.0.0.tgz", + "integrity": "sha512-nIeuVSzdCCs6TDPTqI8w1Yre34sSq7AkZ4B3sfOBbI2CgVSB4Du4aLQijFU2+lhAFCwt9+42Hel6lQNIv6AntQ==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.1.11" + } + }, "node_modules/kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -10432,6 +10983,16 @@ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "license": "MIT" }, + "node_modules/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "uc.micro": "^2.0.0" + } + }, "node_modules/loader-runner": { "version": "4.3.1", "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.1.tgz", @@ -10550,6 +11111,24 @@ "yallist": "^3.0.2" } }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "license": "MIT" + }, + "node_modules/lunr-languages": { + "version": "1.14.0", + "resolved": "https://registry.npmjs.org/lunr-languages/-/lunr-languages-1.14.0.tgz", + "integrity": "sha512-hWUAb2KqM3L7J5bcrngszzISY4BxrXn/Xhbb9TTCJYEGqlR1nG67/M14sp09+PTIRklobrn57IAxcdcO/ZFyNA==", + "license": "MPL-1.1" + }, + "node_modules/mark.js": { + "version": "8.11.1", + "resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz", + "integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==", + "license": "MIT" + }, "node_modules/markdown-extensions": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz", @@ -10562,6 +11141,24 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/markdown-it": { + "version": "14.1.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.1.tgz", + "integrity": "sha512-BuU2qnTti9YKgK5N+IeMubp14ZUKUUw7yeJbkjtosvHiP0AZ5c8IAgEMk79D0eC8F23r4Ac/q8cAIFdm2FtyoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, "node_modules/markdown-table": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.4.tgz", @@ -10989,6 +11586,13 @@ "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==", "license": "CC0-1.0" }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true, + "license": "MIT" + }, "node_modules/media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -13510,6 +14114,18 @@ "url": "https://github.com/inikulin/parse5?sponsor=1" } }, + "node_modules/parse5-parser-stream": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/parse5-parser-stream/-/parse5-parser-stream-7.1.2.tgz", + "integrity": "sha512-JyeQc9iwFLn5TbvvqACIF/VXG6abODeB3Fwmv/TGdLk2LfbWkaySGY72at4+Ty7EkPZj854u4CrICqNk2qIbow==", + "license": "MIT", + "dependencies": { + "parse5": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, "node_modules/parse5/node_modules/entities": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", @@ -15220,6 +15836,16 @@ "node": ">=6" } }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/pupa": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.3.0.tgz", @@ -17304,6 +17930,92 @@ "is-typedarray": "^1.0.0" } }, + "node_modules/typedoc": { + "version": "0.28.18", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.18.tgz", + "integrity": "sha512-NTWTUOFRQ9+SGKKTuWKUioUkjxNwtS3JDRPVKZAXGHZy2wCA8bdv2iJiyeePn0xkmK+TCCqZFT0X7+2+FLjngA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@gerrit0/mini-shiki": "^3.23.0", + "lunr": "^2.3.9", + "markdown-it": "^14.1.1", + "minimatch": "^10.2.4", + "yaml": "^2.8.2" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 18", + "pnpm": ">= 10" + }, + "peerDependencies": { + "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x || 6.0.x" + } + }, + "node_modules/typedoc-docusaurus-theme": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/typedoc-docusaurus-theme/-/typedoc-docusaurus-theme-1.4.2.tgz", + "integrity": "sha512-i9YYDcScLD0WUiX8I+LXHX3ZVvRDlJsmRo9l/uWrFT37cHlMz4Ay0GOnWzHUBnnwAo1uzYOw9RjUXznbWozBEA==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "typedoc-plugin-markdown": ">=4.8.0" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "4.11.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.11.0.tgz", + "integrity": "sha512-2iunh2ALyfyh204OF7h2u0kuQ84xB3jFZtFyUr01nThJkLvR8oGGSSDlyt2gyO4kXhvUxDcVbO0y43+qX+wFbw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typedoc": "0.28.x" + } + }, + "node_modules/typedoc/node_modules/balanced-match": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", + "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz", + "integrity": "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^4.0.2" + }, + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "10.2.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.4.tgz", + "integrity": "sha512-oRjTw/97aTBN0RHbYCdtF1MQfvusSIBQM0IZEgzl6426+8jSC0nF1a/GmnVLpfB9yyr6g6FTqWqiZVbxrtaCIg==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "brace-expansion": "^5.0.2" + }, + "engines": { + "node": "18 || 20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/typescript": { "version": "5.6.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", @@ -17318,6 +18030,22 @@ "node": ">=14.17" } }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true, + "license": "MIT" + }, + "node_modules/undici": { + "version": "7.24.6", + "resolved": "https://registry.npmjs.org/undici/-/undici-7.24.6.tgz", + "integrity": "sha512-Xi4agocCbRzt0yYMZGMA6ApD7gvtUFaxm4ZmeacWI4cZxaF6C+8I8QfofC20NAePiB/IcvZmzkJ7XPa471AEtA==", + "license": "MIT", + "engines": { + "node": ">=20.18.1" + } + }, "node_modules/undici-types": { "version": "7.18.2", "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", @@ -18237,6 +18965,40 @@ "node": ">=0.8.0" } }, + "node_modules/whatwg-encoding": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", + "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==", + "deprecated": "Use @exodus/bytes instead for a more spec-conformant and faster implementation", + "license": "MIT", + "dependencies": { + "iconv-lite": "0.6.3" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/whatwg-encoding/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/whatwg-mimetype": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", + "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", @@ -18422,6 +19184,22 @@ "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", "license": "ISC" }, + "node_modules/yaml": { + "version": "2.8.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.3.tgz", + "integrity": "sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==", + "dev": true, + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" + } + }, "node_modules/yocto-queue": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", diff --git a/website/package.json b/website/package.json index 452e8815d3d..6e7c4f4fe87 100644 --- a/website/package.json +++ b/website/package.json @@ -17,6 +17,7 @@ "dependencies": { "@docusaurus/core": "3.9.2", "@docusaurus/preset-classic": "3.9.2", + "@easyops-cn/docusaurus-search-local": "^0.55.1", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", @@ -27,6 +28,9 @@ "@docusaurus/module-type-aliases": "3.9.2", "@docusaurus/tsconfig": "3.9.2", "@docusaurus/types": "3.9.2", + "docusaurus-plugin-typedoc": "^1.4.2", + "typedoc": "^0.28.18", + "typedoc-plugin-markdown": "^4.11.0", "typescript": "~5.6.2" }, "browserslist": { diff --git a/website/scripts/transform-gen-docs.mjs b/website/scripts/transform-gen-docs.mjs new file mode 100644 index 00000000000..7de12821038 --- /dev/null +++ b/website/scripts/transform-gen-docs.mjs @@ -0,0 +1,336 @@ +#!/usr/bin/env node + +import { readFileSync, readdirSync, mkdirSync, writeFileSync, rmSync } from 'node:fs'; +import { dirname, extname, join, resolve } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = dirname(__filename); + +const CATEGORY_SLUG_BY_NAME = { + 'Core Resources': 'core-resources', + Workloads: 'workloads', + Networking: 'networking', + Security: 'security', + 'Configuration & Storage': 'configuration-storage', + Cluster: 'cluster', + Other: 'other', +}; + +const CATEGORY_ORDER = [ + 'Core Resources', + 'Workloads', + 'Networking', + 'Security', + 'Configuration & Storage', + 'Cluster', + 'Other', +]; + +function toPosixPath(p) { + return p.replaceAll('\\\\', '/'); +} + +function normalizeTitle(value) { + return value.replace(/^\.+/, ''); +} + +function loadApiGroupMap(mapPath) { + const raw = readFileSync(mapPath, 'utf8'); + return JSON.parse(raw); +} + +function stripExistingFrontmatter(content) { + if (!content.startsWith('---\n')) { + return content; + } + + const endMarker = content.indexOf('\n---\n', 4); + if (endMarker === -1) { + return content; + } + + return content.slice(endMarker + '\n---\n'.length); +} + +function rewriteLinks(content, apiGroupMap, warnings) { + const apiLinkPattern = /\(([^)\s]+\.md)#([^)\s]+)\)/g; + let result = content.replace(apiLinkPattern, (full, targetFile, anchor) => { + const className = targetFile.replace(/\.md$/, ''); + if (!className.endsWith('Api')) { + return full; + } + const meta = apiGroupMap[className]; + if (!meta) { + warnings.push(`No api-group-map entry for ${className}`); + return full; + } + + const slug = CATEGORY_SLUG_BY_NAME[meta.category]; + if (!slug) { + warnings.push(`No category slug mapping for category \"${meta.category}\" (${className})`); + return full; + } + + return `(/docs/api-reference/${slug}/${className}#${anchor})`; + }); + + // README references: rewrite BearerToken to local authorization section, drop others to plain text. + result = result.replace(/\[BearerToken\]\(README\.md#BearerToken\)/g, '[BearerToken](#authorization)'); + result = result.replace(/\[([^\]]+)\]\(README\.md#[^)]+\)/g, '$1'); + result = result.replace(/\(README\.md#[^)]+\)/g, ''); + + return result; +} + +function normalizeHeadings(content) { + let result = content; + + // Main title heading (# .CoreV1Api -> # CoreV1Api) + result = result.replace(/^#\s+\.([^\n]+)$/m, (_, title) => `# ${normalizeTitle(title.trim())}`); + + // Method heading normalization with explicit anchor. + const lines = result.split('\n'); + const out = []; + + for (let i = 0; i < lines.length; i += 1) { + const line = lines[i]; + const boldMethodMatch = line.match(/^#\s+\*\*([^*]+)\*\*\s*$/); + if (!boldMethodMatch) { + out.push(line); + continue; + } + + const method = boldMethodMatch[1].trim(); + out.push(`### ${method}`); + + const nextLine = lines[i + 1] ?? ''; + const nextNextLine = lines[i + 2] ?? ''; + const alreadyAnchored = nextLine.trim() === '' && nextNextLine.trim() === ``; + + if (!alreadyAnchored) { + out.push(''); + out.push(``); + } + } + + result = out.join('\n'); + + // Ensure any existing method anchor after ### heading is exactly one blank line then anchor. + result = result.replace( + /^###\s+([A-Za-z0-9_]+)\s*\n(?:\n)?(<\/a>)?/gm, + (_, method) => `### ${method}\n\n\n`, + ); + + return result; +} + +function fixImports(content) { + return content + .replace(/from\s+''/g, "from '@kubernetes/client-node'") + .replace(/from\s+\"\"/g, "from '@kubernetes/client-node'"); +} + +function cleanupContent(content) { + let result = content; + + // Footer cleanup + result = result.replace(/^\[\[Back to top\]\].*$/gm, ''); + + // Unbold model names in return signatures and return type sections + result = result.replace(/^>\s+\*\*([^*]+)\*\*(\s+.+)$/gm, '> $1$2'); + result = result.replace(/^\*\*([^*]+)\*\*$/gm, '$1'); + + // Trim trailing spaces and collapse excessive end-newlines. + result = result + .split('\n') + .map((line) => line.replace(/\s+$/g, '')) + .join('\n') + .replace(/\n{3,}/g, '\n\n') + .replace(/\s*$/g, '\n'); + + return result; +} + +function makeFrontmatter({ id, title, sidebarLabel, sidebarPosition }) { + return [ + '---', + `id: ${id}`, + `title: ${title}`, + `sidebar_label: ${sidebarLabel}`, + `sidebar_position: ${sidebarPosition}`, + '---', + '', + ].join('\n'); +} + +export function transformMarkdown(content, { className, sidebarPosition, apiGroupMap, warnings }) { + const withoutFrontmatter = stripExistingFrontmatter(content); + const title = normalizeTitle(className); + + let transformed = withoutFrontmatter; + transformed = normalizeHeadings(transformed); + transformed = rewriteLinks(transformed, apiGroupMap, warnings); + transformed = fixImports(transformed); + transformed = cleanupContent(transformed); + + const frontmatter = makeFrontmatter({ + id: className, + title, + sidebarLabel: title, + sidebarPosition, + }); + + return `${frontmatter}${transformed}`; +} + +function buildCategoryIndex(apiGroupMap) { + const byCategory = new Map(CATEGORY_ORDER.map((category) => [category, []])); + + for (const className of Object.keys(apiGroupMap).sort()) { + const category = apiGroupMap[className]?.category ?? 'Other'; + if (!byCategory.has(category)) { + byCategory.set(category, []); + } + byCategory.get(category).push(className); + } + + return byCategory; +} + +function writeCategoryFiles(outputRoot) { + CATEGORY_ORDER.forEach((category, index) => { + const slug = CATEGORY_SLUG_BY_NAME[category]; + if (!slug) { + return; + } + + const categoryDir = join(outputRoot, slug); + mkdirSync(categoryDir, { recursive: true }); + + const categoryMeta = { + label: category, + position: index + 1, + }; + + writeFileSync( + join(categoryDir, '_category_.json'), + `${JSON.stringify(categoryMeta, null, 2)}\n`, + 'utf8', + ); + }); +} + +function validateOutputs(outputRoot, warnings) { + const mdFiles = []; + + for (const slug of Object.values(CATEGORY_SLUG_BY_NAME)) { + const dir = join(outputRoot, slug); + let files = []; + try { + files = readdirSync(dir).filter((f) => extname(f) === '.md'); + } catch { + continue; + } + + for (const file of files) { + mdFiles.push(join(dir, file)); + } + } + + for (const filePath of mdFiles) { + const raw = readFileSync(filePath, 'utf8'); + if (raw.includes("from ''") || raw.includes('from ""')) { + throw new Error(`Validation failed: empty import path in ${filePath}`); + } + if (!raw.startsWith('---\n')) { + throw new Error(`Validation failed: missing frontmatter in ${filePath}`); + } + if (/^#\s+\./m.test(raw)) { + throw new Error(`Validation failed: dotted title heading remains in ${filePath}`); + } + } + + return { fileCount: mdFiles.length, warningCount: warnings.length }; +} + +export function runTransform({ + docsDir = resolve(__dirname, '../../src/gen/docs'), + outputDir = resolve(__dirname, '../docs/api-reference'), + mapPath = resolve(__dirname, './api-group-map.json'), +} = {}) { + const apiGroupMap = loadApiGroupMap(mapPath); + const byCategory = buildCategoryIndex(apiGroupMap); + const warnings = []; + + const inputFiles = readdirSync(docsDir) + .filter((name) => extname(name) === '.md') + .sort((a, b) => a.localeCompare(b)); + + // Clean output tree for deterministic idempotent output. + rmSync(outputDir, { recursive: true, force: true }); + mkdirSync(outputDir, { recursive: true }); + writeCategoryFiles(outputDir); + + for (const [categoryIndex, category] of CATEGORY_ORDER.entries()) { + const slug = CATEGORY_SLUG_BY_NAME[category]; + const classNames = (byCategory.get(category) ?? []).slice().sort((a, b) => a.localeCompare(b)); + + for (const className of classNames) { + const inputFileName = `${className}.md`; + if (!inputFiles.includes(inputFileName)) { + warnings.push(`Missing input markdown for ${className}`); + continue; + } + + const inputPath = join(docsDir, inputFileName); + const outputPath = join(outputDir, slug, inputFileName); + const source = readFileSync(inputPath, 'utf8'); + const sidebarPosition = classNames.indexOf(className) + 1; + + const transformed = transformMarkdown(source, { + className, + sidebarPosition, + apiGroupMap, + warnings, + }); + + writeFileSync(outputPath, transformed, 'utf8'); + } + + void categoryIndex; + } + + // Process any input file not represented in map as "Other". + const mappedNames = new Set(Object.keys(apiGroupMap)); + const unmappedInputs = inputFiles + .map((f) => f.replace(/\.md$/, '')) + .filter((className) => !mappedNames.has(className)) + .sort((a, b) => a.localeCompare(b)); + + for (const className of unmappedInputs) { + warnings.push(`Unmapped class ${className}; emitted under Other`); + const inputPath = join(docsDir, `${className}.md`); + const outputPath = join(outputDir, CATEGORY_SLUG_BY_NAME.Other, `${className}.md`); + const source = readFileSync(inputPath, 'utf8'); + const existingCount = readdirSync(join(outputDir, CATEGORY_SLUG_BY_NAME.Other)).filter((f) => + f.endsWith('.md'), + ).length; + + const transformed = transformMarkdown(source, { + className, + sidebarPosition: existingCount + 1, + apiGroupMap, + warnings, + }); + writeFileSync(outputPath, transformed, 'utf8'); + } + + const { fileCount, warningCount } = validateOutputs(outputDir, warnings); + return { fileCount, warningCount, outputDir: toPosixPath(outputDir) }; +} + +if (process.argv[1] && resolve(process.argv[1]) === __filename) { + const result = runTransform(); + console.log(`Transformed ${result.fileCount} files with ${result.warningCount} warnings`); +} diff --git a/website/sidebars.ts b/website/sidebars.ts index 289713975cd..669d3ba9dad 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -1,33 +1,89 @@ -import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; - -// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) +import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; /** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. + * Sidebar configuration for Kubernetes JavaScript Client documentation. + * + * Structure: + * - Getting Started: Introduction and setup guide + * - SDK Reference: Client library modules (config, watch, exec, etc.) + * - Kubernetes API Reference: Auto-generated from OpenAPI spec with groupings */ const sidebars: SidebarsConfig = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], - */ + docs: [ + { + type: 'category', + label: 'Getting Started', + collapsed: false, + items: ['intro'], + }, + { + type: 'category', + label: 'SDK Reference', + collapsed: false, + items: [ + { + type: 'category', + label: 'Configuration', + link: { type: 'generated-index' }, + items: [ + { type: 'autogenerated', dirName: 'sdk/config' }, + { type: 'autogenerated', dirName: 'sdk/config_types' }, + ], + }, + { + type: 'category', + label: 'Watching & Caching', + link: { type: 'generated-index' }, + items: [ + { type: 'autogenerated', dirName: 'sdk/watch' }, + { type: 'autogenerated', dirName: 'sdk/informer' }, + { type: 'autogenerated', dirName: 'sdk/cache' }, + ], + }, + { + type: 'category', + label: 'Pod Operations', + link: { type: 'generated-index' }, + items: [ + { type: 'autogenerated', dirName: 'sdk/exec' }, + { type: 'autogenerated', dirName: 'sdk/attach' }, + { type: 'autogenerated', dirName: 'sdk/portforward' }, + { type: 'autogenerated', dirName: 'sdk/cp' }, + { type: 'autogenerated', dirName: 'sdk/log' }, + ], + }, + { + type: 'category', + label: 'Cluster Operations', + link: { type: 'generated-index' }, + items: [ + { type: 'autogenerated', dirName: 'sdk/metrics' }, + { type: 'autogenerated', dirName: 'sdk/top' }, + ], + }, + { + type: 'category', + label: 'Utilities', + link: { type: 'generated-index' }, + items: [ + { type: 'autogenerated', dirName: 'sdk/object' }, + { type: 'autogenerated', dirName: 'sdk/patch' }, + { type: 'autogenerated', dirName: 'sdk/health' }, + { type: 'autogenerated', dirName: 'sdk/middleware' }, + { type: 'autogenerated', dirName: 'sdk/types' }, + { type: 'autogenerated', dirName: 'sdk/yaml' }, + ], + }, + ], + }, + { + type: 'category', + label: 'Kubernetes API Reference', + collapsed: false, + link: { type: 'generated-index' }, + items: [{ type: 'autogenerated', dirName: 'api-reference' }], + }, + ], }; export default sidebars; From 5fc0600771d4c6e1fd650f3a14542dc42048bbea Mon Sep 17 00:00:00 2001 From: David Gamero Date: Thu, 26 Mar 2026 17:33:29 -0400 Subject: [PATCH 03/11] docs: wire prebuild hooks, gitignore generated docs, add intro and landing page Task 9: prebuild/prestart hooks run transform-gen-docs.mjs automatically Task 9: .gitignore excludes docs/api-reference/ and docs/sdk/ (generated) Task 9: untrack generated docs from git (regenerated on build) Task 11: custom landing page with install command and quick links Task 11: intro.md with KubeConfig example and compatibility table --- website/.gitignore | 4 + .../cluster/AdmissionregistrationApi.md | 62 - .../cluster/AdmissionregistrationV1Api.md | 3767 -- .../AdmissionregistrationV1alpha1Api.md | 1750 - .../AdmissionregistrationV1beta1Api.md | 1750 - .../api-reference/cluster/ApiextensionsApi.md | 62 - .../cluster/ApiextensionsV1Api.md | 1484 - .../cluster/ApiregistrationApi.md | 62 - .../cluster/ApiregistrationV1Api.md | 1031 - .../api-reference/cluster/SchedulingApi.md | 62 - .../api-reference/cluster/SchedulingV1Api.md | 719 - .../cluster/SchedulingV1alpha1Api.md | 853 - .../api-reference/cluster/_category_.json | 4 - .../configuration-storage/CoordinationApi.md | 62 - .../CoordinationV1Api.md | 835 - .../CoordinationV1alpha2Api.md | 833 - .../CoordinationV1beta1Api.md | 833 - .../configuration-storage/PolicyApi.md | 62 - .../configuration-storage/PolicyV1Api.md | 1191 - .../configuration-storage/StorageApi.md | 62 - .../configuration-storage/StorageV1Api.md | 5308 --- .../StorageV1beta1Api.md | 719 - .../StoragemigrationApi.md | 62 - .../StoragemigrationV1beta1Api.md | 1016 - .../configuration-storage/_category_.json | 4 - .../api-reference/core-resources/CoreApi.md | 62 - .../api-reference/core-resources/CoreV1Api.md | 39221 ---------------- .../api-reference/core-resources/EventsApi.md | 62 - .../core-resources/EventsV1Api.md | 889 - .../api-reference/core-resources/NodeApi.md | 62 - .../api-reference/core-resources/NodeV1Api.md | 751 - .../core-resources/_category_.json | 4 - .../api-reference/networking/DiscoveryApi.md | 62 - .../networking/DiscoveryV1Api.md | 913 - .../api-reference/networking/NetworkingApi.md | 62 - .../networking/NetworkingV1Api.md | 4552 -- .../networking/NetworkingV1beta1Api.md | 1675 - .../api-reference/networking/_category_.json | 4 - website/docs/api-reference/other/ApisApi.md | 62 - .../api-reference/other/AutoscalingApi.md | 62 - .../api-reference/other/AutoscalingV1Api.md | 1125 - .../api-reference/other/AutoscalingV2Api.md | 1833 - .../api-reference/other/CustomObjectsApi.md | 2234 - .../other/FlowcontrolApiserverApi.md | 62 - .../other/FlowcontrolApiserverV1Api.md | 2147 - .../other/InternalApiserverApi.md | 62 - .../other/InternalApiserverV1alpha1Api.md | 1037 - website/docs/api-reference/other/LogsApi.md | 111 - website/docs/api-reference/other/OpenidApi.md | 62 - .../docs/api-reference/other/ResourceApi.md | 62 - .../docs/api-reference/other/ResourceV1Api.md | 4243 -- .../other/ResourceV1alpha3Api.md | 1034 - .../api-reference/other/ResourceV1beta1Api.md | 4237 -- .../api-reference/other/ResourceV1beta2Api.md | 4243 -- .../docs/api-reference/other/VersionApi.md | 62 - .../docs/api-reference/other/WellKnownApi.md | 62 - .../docs/api-reference/other/_category_.json | 4 - .../security/AuthenticationApi.md | 62 - .../security/AuthenticationV1Api.md | 329 - .../security/AuthorizationApi.md | 62 - .../security/AuthorizationV1Api.md | 709 - .../api-reference/security/CertificatesApi.md | 62 - .../security/CertificatesV1Api.md | 1331 - .../security/CertificatesV1alpha1Api.md | 719 - .../security/CertificatesV1beta1Api.md | 1824 - .../security/RbacAuthorizationApi.md | 62 - .../security/RbacAuthorizationV1Api.md | 3034 -- .../api-reference/security/_category_.json | 4 - .../docs/api-reference/workloads/AppsApi.md | 62 - .../docs/api-reference/workloads/AppsV1Api.md | 28122 ----------- .../docs/api-reference/workloads/BatchApi.md | 62 - .../api-reference/workloads/BatchV1Api.md | 13489 ------ .../api-reference/workloads/_category_.json | 4 - website/docs/intro.md | 82 +- website/docs/sdk/attach/classes/Attach.md | 75 - website/docs/sdk/attach/index.md | 5 - website/docs/sdk/cache/classes/ListWatch.md | 248 - .../sdk/cache/functions/addOrUpdateObject.md | 33 - .../sdk/cache/functions/cacheMapFromList.md | 21 - .../docs/sdk/cache/functions/deleteItems.md | 29 - .../docs/sdk/cache/functions/deleteObject.md | 29 - website/docs/sdk/cache/index.md | 20 - .../docs/sdk/cache/interfaces/ObjectCache.md | 49 - .../docs/sdk/cache/type-aliases/CacheMap.md | 11 - website/docs/sdk/config/classes/KubeConfig.md | 559 - .../functions/bufferFromFileOrString.md | 19 - .../docs/sdk/config/functions/findHomeDir.md | 15 - .../docs/sdk/config/functions/findObject.md | 29 - .../sdk/config/functions/makeAbsolutePath.md | 19 - website/docs/sdk/config/index.md | 21 - website/docs/sdk/config/interfaces/ApiType.md | 3 - website/docs/sdk/config/interfaces/Named.md | 11 - .../sdk/config/type-aliases/ApiConstructor.md | 21 - .../config_types/functions/exportCluster.md | 15 - .../config_types/functions/exportContext.md | 15 - .../sdk/config_types/functions/exportUser.md | 15 - .../sdk/config_types/functions/newClusters.md | 19 - .../sdk/config_types/functions/newContexts.md | 19 - .../sdk/config_types/functions/newUsers.md | 19 - website/docs/sdk/config_types/index.md | 25 - .../sdk/config_types/interfaces/Cluster.md | 59 - .../config_types/interfaces/ConfigOptions.md | 11 - .../sdk/config_types/interfaces/Context.md | 35 - .../docs/sdk/config_types/interfaces/User.md | 91 - .../type-aliases/ActionOnInvalid.md | 5 - .../config_types/variables/ActionOnInvalid.md | 15 - website/docs/sdk/cp/classes/Cp.md | 127 - website/docs/sdk/cp/index.md | 5 - website/docs/sdk/exec/classes/Exec.md | 103 - website/docs/sdk/exec/index.md | 5 - website/docs/sdk/health/classes/Health.md | 65 - website/docs/sdk/health/index.md | 5 - website/docs/sdk/index.md | 22 - .../sdk/informer/functions/makeInformer.md | 33 - website/docs/sdk/informer/index.md | 31 - .../docs/sdk/informer/interfaces/Informer.md | 121 - website/docs/sdk/informer/type-aliases/ADD.md | 5 - .../docs/sdk/informer/type-aliases/CHANGE.md | 5 - .../docs/sdk/informer/type-aliases/CONNECT.md | 5 - .../docs/sdk/informer/type-aliases/DELETE.md | 5 - .../docs/sdk/informer/type-aliases/ERROR.md | 5 - .../informer/type-aliases/ErrorCallback.md | 15 - .../sdk/informer/type-aliases/ListCallback.md | 25 - .../sdk/informer/type-aliases/ListPromise.md | 15 - .../informer/type-aliases/ObjectCallback.md | 21 - .../docs/sdk/informer/type-aliases/UPDATE.md | 5 - website/docs/sdk/informer/variables/ADD.md | 5 - website/docs/sdk/informer/variables/CHANGE.md | 5 - .../docs/sdk/informer/variables/CONNECT.md | 5 - website/docs/sdk/informer/variables/DELETE.md | 5 - website/docs/sdk/informer/variables/ERROR.md | 5 - website/docs/sdk/informer/variables/UPDATE.md | 5 - website/docs/sdk/log/classes/Log.md | 105 - .../log/functions/AddOptionsToSearchParams.md | 19 - website/docs/sdk/log/index.md | 13 - website/docs/sdk/log/interfaces/LogOptions.md | 88 - website/docs/sdk/metrics/classes/Metrics.md | 51 - website/docs/sdk/metrics/index.md | 14 - .../sdk/metrics/interfaces/ContainerMetric.md | 19 - .../docs/sdk/metrics/interfaces/NodeMetric.md | 47 - .../sdk/metrics/interfaces/NodeMetricsList.md | 39 - .../docs/sdk/metrics/interfaces/PodMetric.md | 51 - .../sdk/metrics/interfaces/PodMetricsList.md | 39 - website/docs/sdk/metrics/interfaces/Usage.md | 19 - .../functions/setHeaderMiddleware.md | 19 - .../middleware/functions/setHeaderOptions.md | 23 - website/docs/sdk/middleware/index.md | 6 - .../sdk/object/classes/KubernetesObjectApi.md | 466 - website/docs/sdk/object/index.md | 5 - website/docs/sdk/patch/index.md | 9 - .../sdk/patch/type-aliases/PatchStrategy.md | 12 - .../docs/sdk/patch/variables/PatchStrategy.md | 38 - .../sdk/portforward/classes/PortForward.md | 195 - website/docs/sdk/portforward/index.md | 5 - .../docs/sdk/top/classes/ContainerStatus.md | 53 - .../sdk/top/classes/CurrentResourceUsage.md | 53 - website/docs/sdk/top/classes/NodeStatus.md | 53 - website/docs/sdk/top/classes/PodStatus.md | 65 - website/docs/sdk/top/classes/ResourceUsage.md | 53 - website/docs/sdk/top/functions/topNodes.md | 15 - website/docs/sdk/top/functions/topPods.md | 23 - website/docs/sdk/top/index.md | 14 - website/docs/sdk/typedoc-sidebar.cjs | 4 - website/docs/sdk/types/classes/V1MicroTime.md | 141 - website/docs/sdk/types/index.md | 14 - .../types/interfaces/KubernetesListObject.md | 41 - .../sdk/types/interfaces/KubernetesObject.md | 27 - .../sdk/types/type-aliases/IntOrString.md | 5 - website/docs/sdk/watch/classes/Watch.md | 67 - website/docs/sdk/watch/index.md | 5 - website/docs/sdk/yaml/functions/dumpYaml.md | 27 - .../docs/sdk/yaml/functions/loadAllYaml.md | 27 - website/docs/sdk/yaml/functions/loadYaml.md | 33 - website/docs/sdk/yaml/index.md | 7 - website/package.json | 100 +- website/src/pages/index.tsx | 99 +- 176 files changed, 181 insertions(+), 147919 deletions(-) delete mode 100644 website/docs/api-reference/cluster/AdmissionregistrationApi.md delete mode 100644 website/docs/api-reference/cluster/AdmissionregistrationV1Api.md delete mode 100644 website/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api.md delete mode 100644 website/docs/api-reference/cluster/AdmissionregistrationV1beta1Api.md delete mode 100644 website/docs/api-reference/cluster/ApiextensionsApi.md delete mode 100644 website/docs/api-reference/cluster/ApiextensionsV1Api.md delete mode 100644 website/docs/api-reference/cluster/ApiregistrationApi.md delete mode 100644 website/docs/api-reference/cluster/ApiregistrationV1Api.md delete mode 100644 website/docs/api-reference/cluster/SchedulingApi.md delete mode 100644 website/docs/api-reference/cluster/SchedulingV1Api.md delete mode 100644 website/docs/api-reference/cluster/SchedulingV1alpha1Api.md delete mode 100644 website/docs/api-reference/cluster/_category_.json delete mode 100644 website/docs/api-reference/configuration-storage/CoordinationApi.md delete mode 100644 website/docs/api-reference/configuration-storage/CoordinationV1Api.md delete mode 100644 website/docs/api-reference/configuration-storage/CoordinationV1alpha2Api.md delete mode 100644 website/docs/api-reference/configuration-storage/CoordinationV1beta1Api.md delete mode 100644 website/docs/api-reference/configuration-storage/PolicyApi.md delete mode 100644 website/docs/api-reference/configuration-storage/PolicyV1Api.md delete mode 100644 website/docs/api-reference/configuration-storage/StorageApi.md delete mode 100644 website/docs/api-reference/configuration-storage/StorageV1Api.md delete mode 100644 website/docs/api-reference/configuration-storage/StorageV1beta1Api.md delete mode 100644 website/docs/api-reference/configuration-storage/StoragemigrationApi.md delete mode 100644 website/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api.md delete mode 100644 website/docs/api-reference/configuration-storage/_category_.json delete mode 100644 website/docs/api-reference/core-resources/CoreApi.md delete mode 100644 website/docs/api-reference/core-resources/CoreV1Api.md delete mode 100644 website/docs/api-reference/core-resources/EventsApi.md delete mode 100644 website/docs/api-reference/core-resources/EventsV1Api.md delete mode 100644 website/docs/api-reference/core-resources/NodeApi.md delete mode 100644 website/docs/api-reference/core-resources/NodeV1Api.md delete mode 100644 website/docs/api-reference/core-resources/_category_.json delete mode 100644 website/docs/api-reference/networking/DiscoveryApi.md delete mode 100644 website/docs/api-reference/networking/DiscoveryV1Api.md delete mode 100644 website/docs/api-reference/networking/NetworkingApi.md delete mode 100644 website/docs/api-reference/networking/NetworkingV1Api.md delete mode 100644 website/docs/api-reference/networking/NetworkingV1beta1Api.md delete mode 100644 website/docs/api-reference/networking/_category_.json delete mode 100644 website/docs/api-reference/other/ApisApi.md delete mode 100644 website/docs/api-reference/other/AutoscalingApi.md delete mode 100644 website/docs/api-reference/other/AutoscalingV1Api.md delete mode 100644 website/docs/api-reference/other/AutoscalingV2Api.md delete mode 100644 website/docs/api-reference/other/CustomObjectsApi.md delete mode 100644 website/docs/api-reference/other/FlowcontrolApiserverApi.md delete mode 100644 website/docs/api-reference/other/FlowcontrolApiserverV1Api.md delete mode 100644 website/docs/api-reference/other/InternalApiserverApi.md delete mode 100644 website/docs/api-reference/other/InternalApiserverV1alpha1Api.md delete mode 100644 website/docs/api-reference/other/LogsApi.md delete mode 100644 website/docs/api-reference/other/OpenidApi.md delete mode 100644 website/docs/api-reference/other/ResourceApi.md delete mode 100644 website/docs/api-reference/other/ResourceV1Api.md delete mode 100644 website/docs/api-reference/other/ResourceV1alpha3Api.md delete mode 100644 website/docs/api-reference/other/ResourceV1beta1Api.md delete mode 100644 website/docs/api-reference/other/ResourceV1beta2Api.md delete mode 100644 website/docs/api-reference/other/VersionApi.md delete mode 100644 website/docs/api-reference/other/WellKnownApi.md delete mode 100644 website/docs/api-reference/other/_category_.json delete mode 100644 website/docs/api-reference/security/AuthenticationApi.md delete mode 100644 website/docs/api-reference/security/AuthenticationV1Api.md delete mode 100644 website/docs/api-reference/security/AuthorizationApi.md delete mode 100644 website/docs/api-reference/security/AuthorizationV1Api.md delete mode 100644 website/docs/api-reference/security/CertificatesApi.md delete mode 100644 website/docs/api-reference/security/CertificatesV1Api.md delete mode 100644 website/docs/api-reference/security/CertificatesV1alpha1Api.md delete mode 100644 website/docs/api-reference/security/CertificatesV1beta1Api.md delete mode 100644 website/docs/api-reference/security/RbacAuthorizationApi.md delete mode 100644 website/docs/api-reference/security/RbacAuthorizationV1Api.md delete mode 100644 website/docs/api-reference/security/_category_.json delete mode 100644 website/docs/api-reference/workloads/AppsApi.md delete mode 100644 website/docs/api-reference/workloads/AppsV1Api.md delete mode 100644 website/docs/api-reference/workloads/BatchApi.md delete mode 100644 website/docs/api-reference/workloads/BatchV1Api.md delete mode 100644 website/docs/api-reference/workloads/_category_.json delete mode 100644 website/docs/sdk/attach/classes/Attach.md delete mode 100644 website/docs/sdk/attach/index.md delete mode 100644 website/docs/sdk/cache/classes/ListWatch.md delete mode 100644 website/docs/sdk/cache/functions/addOrUpdateObject.md delete mode 100644 website/docs/sdk/cache/functions/cacheMapFromList.md delete mode 100644 website/docs/sdk/cache/functions/deleteItems.md delete mode 100644 website/docs/sdk/cache/functions/deleteObject.md delete mode 100644 website/docs/sdk/cache/index.md delete mode 100644 website/docs/sdk/cache/interfaces/ObjectCache.md delete mode 100644 website/docs/sdk/cache/type-aliases/CacheMap.md delete mode 100644 website/docs/sdk/config/classes/KubeConfig.md delete mode 100644 website/docs/sdk/config/functions/bufferFromFileOrString.md delete mode 100644 website/docs/sdk/config/functions/findHomeDir.md delete mode 100644 website/docs/sdk/config/functions/findObject.md delete mode 100644 website/docs/sdk/config/functions/makeAbsolutePath.md delete mode 100644 website/docs/sdk/config/index.md delete mode 100644 website/docs/sdk/config/interfaces/ApiType.md delete mode 100644 website/docs/sdk/config/interfaces/Named.md delete mode 100644 website/docs/sdk/config/type-aliases/ApiConstructor.md delete mode 100644 website/docs/sdk/config_types/functions/exportCluster.md delete mode 100644 website/docs/sdk/config_types/functions/exportContext.md delete mode 100644 website/docs/sdk/config_types/functions/exportUser.md delete mode 100644 website/docs/sdk/config_types/functions/newClusters.md delete mode 100644 website/docs/sdk/config_types/functions/newContexts.md delete mode 100644 website/docs/sdk/config_types/functions/newUsers.md delete mode 100644 website/docs/sdk/config_types/index.md delete mode 100644 website/docs/sdk/config_types/interfaces/Cluster.md delete mode 100644 website/docs/sdk/config_types/interfaces/ConfigOptions.md delete mode 100644 website/docs/sdk/config_types/interfaces/Context.md delete mode 100644 website/docs/sdk/config_types/interfaces/User.md delete mode 100644 website/docs/sdk/config_types/type-aliases/ActionOnInvalid.md delete mode 100644 website/docs/sdk/config_types/variables/ActionOnInvalid.md delete mode 100644 website/docs/sdk/cp/classes/Cp.md delete mode 100644 website/docs/sdk/cp/index.md delete mode 100644 website/docs/sdk/exec/classes/Exec.md delete mode 100644 website/docs/sdk/exec/index.md delete mode 100644 website/docs/sdk/health/classes/Health.md delete mode 100644 website/docs/sdk/health/index.md delete mode 100644 website/docs/sdk/index.md delete mode 100644 website/docs/sdk/informer/functions/makeInformer.md delete mode 100644 website/docs/sdk/informer/index.md delete mode 100644 website/docs/sdk/informer/interfaces/Informer.md delete mode 100644 website/docs/sdk/informer/type-aliases/ADD.md delete mode 100644 website/docs/sdk/informer/type-aliases/CHANGE.md delete mode 100644 website/docs/sdk/informer/type-aliases/CONNECT.md delete mode 100644 website/docs/sdk/informer/type-aliases/DELETE.md delete mode 100644 website/docs/sdk/informer/type-aliases/ERROR.md delete mode 100644 website/docs/sdk/informer/type-aliases/ErrorCallback.md delete mode 100644 website/docs/sdk/informer/type-aliases/ListCallback.md delete mode 100644 website/docs/sdk/informer/type-aliases/ListPromise.md delete mode 100644 website/docs/sdk/informer/type-aliases/ObjectCallback.md delete mode 100644 website/docs/sdk/informer/type-aliases/UPDATE.md delete mode 100644 website/docs/sdk/informer/variables/ADD.md delete mode 100644 website/docs/sdk/informer/variables/CHANGE.md delete mode 100644 website/docs/sdk/informer/variables/CONNECT.md delete mode 100644 website/docs/sdk/informer/variables/DELETE.md delete mode 100644 website/docs/sdk/informer/variables/ERROR.md delete mode 100644 website/docs/sdk/informer/variables/UPDATE.md delete mode 100644 website/docs/sdk/log/classes/Log.md delete mode 100644 website/docs/sdk/log/functions/AddOptionsToSearchParams.md delete mode 100644 website/docs/sdk/log/index.md delete mode 100644 website/docs/sdk/log/interfaces/LogOptions.md delete mode 100644 website/docs/sdk/metrics/classes/Metrics.md delete mode 100644 website/docs/sdk/metrics/index.md delete mode 100644 website/docs/sdk/metrics/interfaces/ContainerMetric.md delete mode 100644 website/docs/sdk/metrics/interfaces/NodeMetric.md delete mode 100644 website/docs/sdk/metrics/interfaces/NodeMetricsList.md delete mode 100644 website/docs/sdk/metrics/interfaces/PodMetric.md delete mode 100644 website/docs/sdk/metrics/interfaces/PodMetricsList.md delete mode 100644 website/docs/sdk/metrics/interfaces/Usage.md delete mode 100644 website/docs/sdk/middleware/functions/setHeaderMiddleware.md delete mode 100644 website/docs/sdk/middleware/functions/setHeaderOptions.md delete mode 100644 website/docs/sdk/middleware/index.md delete mode 100644 website/docs/sdk/object/classes/KubernetesObjectApi.md delete mode 100644 website/docs/sdk/object/index.md delete mode 100644 website/docs/sdk/patch/index.md delete mode 100644 website/docs/sdk/patch/type-aliases/PatchStrategy.md delete mode 100644 website/docs/sdk/patch/variables/PatchStrategy.md delete mode 100644 website/docs/sdk/portforward/classes/PortForward.md delete mode 100644 website/docs/sdk/portforward/index.md delete mode 100644 website/docs/sdk/top/classes/ContainerStatus.md delete mode 100644 website/docs/sdk/top/classes/CurrentResourceUsage.md delete mode 100644 website/docs/sdk/top/classes/NodeStatus.md delete mode 100644 website/docs/sdk/top/classes/PodStatus.md delete mode 100644 website/docs/sdk/top/classes/ResourceUsage.md delete mode 100644 website/docs/sdk/top/functions/topNodes.md delete mode 100644 website/docs/sdk/top/functions/topPods.md delete mode 100644 website/docs/sdk/top/index.md delete mode 100644 website/docs/sdk/typedoc-sidebar.cjs delete mode 100644 website/docs/sdk/types/classes/V1MicroTime.md delete mode 100644 website/docs/sdk/types/index.md delete mode 100644 website/docs/sdk/types/interfaces/KubernetesListObject.md delete mode 100644 website/docs/sdk/types/interfaces/KubernetesObject.md delete mode 100644 website/docs/sdk/types/type-aliases/IntOrString.md delete mode 100644 website/docs/sdk/watch/classes/Watch.md delete mode 100644 website/docs/sdk/watch/index.md delete mode 100644 website/docs/sdk/yaml/functions/dumpYaml.md delete mode 100644 website/docs/sdk/yaml/functions/loadAllYaml.md delete mode 100644 website/docs/sdk/yaml/functions/loadYaml.md delete mode 100644 website/docs/sdk/yaml/index.md diff --git a/website/.gitignore b/website/.gitignore index b2d6de30624..eb2c5dbb547 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -18,3 +18,7 @@ npm-debug.log* yarn-debug.log* yarn-error.log* + +# Generated documentation (created by prebuild hooks) +docs/api-reference/ +docs/sdk/ diff --git a/website/docs/api-reference/cluster/AdmissionregistrationApi.md b/website/docs/api-reference/cluster/AdmissionregistrationApi.md deleted file mode 100644 index 7b767b754f2..00000000000 --- a/website/docs/api-reference/cluster/AdmissionregistrationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AdmissionregistrationApi -title: AdmissionregistrationApi -sidebar_label: AdmissionregistrationApi -sidebar_position: 1 ---- -# AdmissionregistrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/cluster/AdmissionregistrationApi#getAPIGroup) | **GET** /apis/admissionregistration.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/AdmissionregistrationV1Api.md b/website/docs/api-reference/cluster/AdmissionregistrationV1Api.md deleted file mode 100644 index 998daa88cab..00000000000 --- a/website/docs/api-reference/cluster/AdmissionregistrationV1Api.md +++ /dev/null @@ -1,3767 +0,0 @@ ---- -id: AdmissionregistrationV1Api -title: AdmissionregistrationV1Api -sidebar_label: AdmissionregistrationV1Api -sidebar_position: 3 ---- -# AdmissionregistrationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createMutatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**createValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**createValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**createValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**deleteCollectionMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**deleteCollectionValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**deleteCollectionValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**deleteCollectionValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**deleteMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**deleteValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**deleteValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**deleteValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1/ | -[**listMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**listValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**listValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**listValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**patchMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchMutatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**patchValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**patchValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**patchValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicyStatus) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**patchValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**readMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**readValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**readValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**readValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicyStatus) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**readValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**replaceMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceMutatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**replaceValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**replaceValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**replaceValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicyStatus) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**replaceValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | - -### createMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfiguration createMutatingWebhookConfiguration(body) - -create a MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - reinvocationPolicy: "reinvocationPolicy_example", - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1MutatingWebhookConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicy createValidatingAdmissionPolicy(body) - -create a ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBinding createValidatingAdmissionPolicyBinding(body) - -create a ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - validationActions: [ - "validationActions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfiguration createValidatingWebhookConfiguration(body) - -create a ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingWebhookConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingWebhookConfiguration - - - -> V1Status deleteCollectionMutatingWebhookConfiguration() - -delete collection of MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionValidatingAdmissionPolicy - - - -> V1Status deleteCollectionValidatingAdmissionPolicy() - -delete collection of ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionValidatingAdmissionPolicyBinding - - - -> V1Status deleteCollectionValidatingAdmissionPolicyBinding() - -delete collection of ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionValidatingWebhookConfiguration - - - -> V1Status deleteCollectionValidatingWebhookConfiguration() - -delete collection of ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteMutatingWebhookConfiguration - - - -> V1Status deleteMutatingWebhookConfiguration() - -delete a MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteValidatingAdmissionPolicy - - - -> V1Status deleteValidatingAdmissionPolicy() - -delete a ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteValidatingAdmissionPolicyBinding - - - -> V1Status deleteValidatingAdmissionPolicyBinding() - -delete a ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteValidatingWebhookConfiguration - - - -> V1Status deleteValidatingWebhookConfiguration() - -delete a ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfigurationList listMutatingWebhookConfiguration() - -list or watch objects of kind MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfigurationList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicyList listValidatingAdmissionPolicy() - -list or watch objects of kind ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBindingList listValidatingAdmissionPolicyBinding() - -list or watch objects of kind ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfigurationList listValidatingWebhookConfiguration() - -list or watch objects of kind ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfigurationList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfiguration patchMutatingWebhookConfiguration(body) - -partially update the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicy(body) - -partially update the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBinding patchValidatingAdmissionPolicyBinding(body) - -partially update the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchValidatingAdmissionPolicyStatus - - - -> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicyStatus(body) - -partially update status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfiguration patchValidatingWebhookConfiguration(body) - -partially update the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfiguration readMutatingWebhookConfiguration() - -read the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicy() - -read the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBinding readValidatingAdmissionPolicyBinding() - -read the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readValidatingAdmissionPolicyStatus - - - -> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicyStatus() - -read status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfiguration readValidatingWebhookConfiguration() - -read the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfiguration replaceMutatingWebhookConfiguration(body) - -replace the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - reinvocationPolicy: "reinvocationPolicy_example", - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1MutatingWebhookConfiguration**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicy(body) - -replace the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBinding replaceValidatingAdmissionPolicyBinding(body) - -replace the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - validationActions: [ - "validationActions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceValidatingAdmissionPolicyStatus - - - -> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicyStatus(body) - -replace status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfiguration replaceValidatingWebhookConfiguration(body) - -replace the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingWebhookConfiguration**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api.md b/website/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api.md deleted file mode 100644 index 353f1bf6d99..00000000000 --- a/website/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api.md +++ /dev/null @@ -1,1750 +0,0 @@ ---- -id: AdmissionregistrationV1alpha1Api -title: AdmissionregistrationV1alpha1Api -sidebar_label: AdmissionregistrationV1alpha1Api -sidebar_position: 2 ---- -# AdmissionregistrationV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**createMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**deleteCollectionMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**deleteCollectionMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**deleteMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**deleteMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/ | -[**listMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**listMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**patchMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**patchMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**readMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**readMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**replaceMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**replaceMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | - -### createMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) - -create a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) - -create a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingAdmissionPolicy - - - -> V1Status deleteCollectionMutatingAdmissionPolicy() - -delete collection of MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingAdmissionPolicyBinding - - - -> V1Status deleteCollectionMutatingAdmissionPolicyBinding() - -delete collection of MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteMutatingAdmissionPolicy - - - -> V1Status deleteMutatingAdmissionPolicy() - -delete a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteMutatingAdmissionPolicyBinding - - - -> V1Status deleteMutatingAdmissionPolicyBinding() - -delete a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() - -list or watch objects of kind MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() - -list or watch objects of kind MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) - -partially update the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) - -partially update the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicy readMutatingAdmissionPolicy() - -read the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() - -read the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) - -replace the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicy**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) - -replace the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/AdmissionregistrationV1beta1Api.md b/website/docs/api-reference/cluster/AdmissionregistrationV1beta1Api.md deleted file mode 100644 index e27b1f8e351..00000000000 --- a/website/docs/api-reference/cluster/AdmissionregistrationV1beta1Api.md +++ /dev/null @@ -1,1750 +0,0 @@ ---- -id: AdmissionregistrationV1beta1Api -title: AdmissionregistrationV1beta1Api -sidebar_label: AdmissionregistrationV1beta1Api -sidebar_position: 4 ---- -# AdmissionregistrationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**createMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**deleteCollectionMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**deleteCollectionMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**deleteMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**deleteMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1beta1/ | -[**listMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**listMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**patchMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**patchMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**readMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**readMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**replaceMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**replaceMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | - -### createMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) - -create a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) - -create a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingAdmissionPolicy - - - -> V1Status deleteCollectionMutatingAdmissionPolicy() - -delete collection of MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingAdmissionPolicyBinding - - - -> V1Status deleteCollectionMutatingAdmissionPolicyBinding() - -delete collection of MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteMutatingAdmissionPolicy - - - -> V1Status deleteMutatingAdmissionPolicy() - -delete a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteMutatingAdmissionPolicyBinding - - - -> V1Status deleteMutatingAdmissionPolicyBinding() - -delete a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() - -list or watch objects of kind MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() - -list or watch objects of kind MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) - -partially update the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) - -partially update the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicy readMutatingAdmissionPolicy() - -read the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() - -read the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) - -replace the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicy**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) - -replace the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/ApiextensionsApi.md b/website/docs/api-reference/cluster/ApiextensionsApi.md deleted file mode 100644 index ea5d8022ad9..00000000000 --- a/website/docs/api-reference/cluster/ApiextensionsApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: ApiextensionsApi -title: ApiextensionsApi -sidebar_label: ApiextensionsApi -sidebar_position: 5 ---- -# ApiextensionsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/cluster/ApiextensionsApi#getAPIGroup) | **GET** /apis/apiextensions.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ApiextensionsApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/ApiextensionsV1Api.md b/website/docs/api-reference/cluster/ApiextensionsV1Api.md deleted file mode 100644 index bd87829b480..00000000000 --- a/website/docs/api-reference/cluster/ApiextensionsV1Api.md +++ /dev/null @@ -1,1484 +0,0 @@ ---- -id: ApiextensionsV1Api -title: ApiextensionsV1Api -sidebar_label: ApiextensionsV1Api -sidebar_position: 6 ---- -# ApiextensionsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#createCustomResourceDefinition) | **POST** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**deleteCollectionCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#deleteCollectionCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**deleteCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#deleteCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**getAPIResources**](/docs/api-reference/cluster/ApiextensionsV1Api#getAPIResources) | **GET** /apis/apiextensions.k8s.io/v1/ | -[**listCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#listCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**patchCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#patchCustomResourceDefinition) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**patchCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#patchCustomResourceDefinitionStatus) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | -[**readCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#readCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**readCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#readCustomResourceDefinitionStatus) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | -[**replaceCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#replaceCustomResourceDefinition) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**replaceCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#replaceCustomResourceDefinitionStatus) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | - -### createCustomResourceDefinition - - - -> V1CustomResourceDefinition createCustomResourceDefinition(body) - -create a CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiCreateCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiCreateCustomResourceDefinitionRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionCustomResourceDefinition - - - -> V1Status deleteCollectionCustomResourceDefinition() - -delete collection of CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCustomResourceDefinition - - - -> V1Status deleteCustomResourceDefinition() - -delete a CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCustomResourceDefinition - - - -> V1CustomResourceDefinitionList listCustomResourceDefinition() - -list or watch objects of kind CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiListCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiListCustomResourceDefinitionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinitionList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchCustomResourceDefinition - - - -> V1CustomResourceDefinition patchCustomResourceDefinition(body) - -partially update the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiPatchCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiPatchCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchCustomResourceDefinitionStatus - - - -> V1CustomResourceDefinition patchCustomResourceDefinitionStatus(body) - -partially update status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readCustomResourceDefinition - - - -> V1CustomResourceDefinition readCustomResourceDefinition() - -read the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiReadCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReadCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readCustomResourceDefinitionStatus - - - -> V1CustomResourceDefinition readCustomResourceDefinitionStatus() - -read status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceCustomResourceDefinition - - - -> V1CustomResourceDefinition replaceCustomResourceDefinition(body) - -replace the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceCustomResourceDefinitionStatus - - - -> V1CustomResourceDefinition replaceCustomResourceDefinitionStatus(body) - -replace status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/ApiregistrationApi.md b/website/docs/api-reference/cluster/ApiregistrationApi.md deleted file mode 100644 index d129ebb0855..00000000000 --- a/website/docs/api-reference/cluster/ApiregistrationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: ApiregistrationApi -title: ApiregistrationApi -sidebar_label: ApiregistrationApi -sidebar_position: 7 ---- -# ApiregistrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/cluster/ApiregistrationApi#getAPIGroup) | **GET** /apis/apiregistration.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ApiregistrationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/ApiregistrationV1Api.md b/website/docs/api-reference/cluster/ApiregistrationV1Api.md deleted file mode 100644 index 962919a679a..00000000000 --- a/website/docs/api-reference/cluster/ApiregistrationV1Api.md +++ /dev/null @@ -1,1031 +0,0 @@ ---- -id: ApiregistrationV1Api -title: ApiregistrationV1Api -sidebar_label: ApiregistrationV1Api -sidebar_position: 8 ---- -# ApiregistrationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#createAPIService) | **POST** /apis/apiregistration.k8s.io/v1/apiservices | -[**deleteAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#deleteAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**deleteCollectionAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#deleteCollectionAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices | -[**getAPIResources**](/docs/api-reference/cluster/ApiregistrationV1Api#getAPIResources) | **GET** /apis/apiregistration.k8s.io/v1/ | -[**listAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#listAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices | -[**patchAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#patchAPIService) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**patchAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#patchAPIServiceStatus) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | -[**readAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#readAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**readAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#readAPIServiceStatus) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | -[**replaceAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#replaceAPIService) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**replaceAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#replaceAPIServiceStatus) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | - -### createAPIService - - - -> V1APIService createAPIService(body) - -create an APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiCreateAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiCreateAPIServiceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteAPIService - - - -> V1Status deleteAPIService() - -delete an APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiDeleteAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiDeleteAPIServiceRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionAPIService - - - -> V1Status deleteCollectionAPIService() - -delete collection of APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiDeleteCollectionAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiDeleteCollectionAPIServiceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listAPIService - - - -> V1APIServiceList listAPIService() - -list or watch objects of kind APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiListAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiListAPIServiceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1APIServiceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchAPIService - - - -> V1APIService patchAPIService(body) - -partially update the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiPatchAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiPatchAPIServiceRequest = { - // name of the APIService - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchAPIServiceStatus - - - -> V1APIService patchAPIServiceStatus(body) - -partially update status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiPatchAPIServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiPatchAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readAPIService - - - -> V1APIService readAPIService() - -read the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiReadAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReadAPIServiceRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readAPIServiceStatus - - - -> V1APIService readAPIServiceStatus() - -read status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiReadAPIServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReadAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceAPIService - - - -> V1APIService replaceAPIService(body) - -replace the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiReplaceAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReplaceAPIServiceRequest = { - // name of the APIService - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceAPIServiceStatus - - - -> V1APIService replaceAPIServiceStatus(body) - -replace status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiReplaceAPIServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReplaceAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/SchedulingApi.md b/website/docs/api-reference/cluster/SchedulingApi.md deleted file mode 100644 index 574a8c7d9b8..00000000000 --- a/website/docs/api-reference/cluster/SchedulingApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: SchedulingApi -title: SchedulingApi -sidebar_label: SchedulingApi -sidebar_position: 9 ---- -# SchedulingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/cluster/SchedulingApi#getAPIGroup) | **GET** /apis/scheduling.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, SchedulingApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/SchedulingV1Api.md b/website/docs/api-reference/cluster/SchedulingV1Api.md deleted file mode 100644 index 2bb8614b6f4..00000000000 --- a/website/docs/api-reference/cluster/SchedulingV1Api.md +++ /dev/null @@ -1,719 +0,0 @@ ---- -id: SchedulingV1Api -title: SchedulingV1Api -sidebar_label: SchedulingV1Api -sidebar_position: 11 ---- -# SchedulingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#createPriorityClass) | **POST** /apis/scheduling.k8s.io/v1/priorityclasses | -[**deleteCollectionPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#deleteCollectionPriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses | -[**deletePriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#deletePriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**getAPIResources**](/docs/api-reference/cluster/SchedulingV1Api#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1/ | -[**listPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#listPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses | -[**patchPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#patchPriorityClass) | **PATCH** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**readPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#readPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**replacePriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#replacePriorityClass) | **PUT** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | - -### createPriorityClass - - - -> V1PriorityClass createPriorityClass(body) - -create a PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiCreatePriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiCreatePriorityClassRequest = { - - body: { - apiVersion: "apiVersion_example", - description: "description_example", - globalDefault: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - preemptionPolicy: "preemptionPolicy_example", - value: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionPriorityClass - - - -> V1Status deleteCollectionPriorityClass() - -delete collection of PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiDeleteCollectionPriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiDeleteCollectionPriorityClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deletePriorityClass - - - -> V1Status deletePriorityClass() - -delete a PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiDeletePriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiDeletePriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPriorityClass - - - -> V1PriorityClassList listPriorityClass() - -list or watch objects of kind PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiListPriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiListPriorityClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PriorityClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchPriorityClass - - - -> V1PriorityClass patchPriorityClass(body) - -partially update the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiPatchPriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiPatchPriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PriorityClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readPriorityClass - - - -> V1PriorityClass readPriorityClass() - -read the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiReadPriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiReadPriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PriorityClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replacePriorityClass - - - -> V1PriorityClass replacePriorityClass(body) - -replace the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiReplacePriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiReplacePriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - description: "description_example", - globalDefault: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - preemptionPolicy: "preemptionPolicy_example", - value: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityClass**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/SchedulingV1alpha1Api.md b/website/docs/api-reference/cluster/SchedulingV1alpha1Api.md deleted file mode 100644 index 73e5bfc18f5..00000000000 --- a/website/docs/api-reference/cluster/SchedulingV1alpha1Api.md +++ /dev/null @@ -1,853 +0,0 @@ ---- -id: SchedulingV1alpha1Api -title: SchedulingV1alpha1Api -sidebar_label: SchedulingV1alpha1Api -sidebar_position: 10 ---- -# SchedulingV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#createNamespacedWorkload) | **POST** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**deleteCollectionNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#deleteCollectionNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**deleteNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#deleteNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**getAPIResources**](/docs/api-reference/cluster/SchedulingV1alpha1Api#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1alpha1/ | -[**listNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#listNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**listWorkloadForAllNamespaces**](/docs/api-reference/cluster/SchedulingV1alpha1Api#listWorkloadForAllNamespaces) | **GET** /apis/scheduling.k8s.io/v1alpha1/workloads | -[**patchNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#patchNamespacedWorkload) | **PATCH** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**readNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#readNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**replaceNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#replaceNamespacedWorkload) | **PUT** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | - -### createNamespacedWorkload - - - -> V1alpha1Workload createNamespacedWorkload(body) - -create a Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controllerRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - podGroups: [ - { - name: "name_example", - policy: { - basic: {}, - gang: { - minCount: 1, - }, - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1Workload**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1Workload - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedWorkload - - - -> V1Status deleteCollectionNamespacedWorkload() - -delete collection of Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedWorkload - - - -> V1Status deleteNamespacedWorkload() - -delete a Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedWorkload - - - -> V1alpha1WorkloadList listNamespacedWorkload() - -list or watch objects of kind Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiListNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiListNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1WorkloadList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listWorkloadForAllNamespaces - - - -> V1alpha1WorkloadList listWorkloadForAllNamespaces() - -list or watch objects of kind Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listWorkloadForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1WorkloadList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedWorkload - - - -> V1alpha1Workload patchNamespacedWorkload(body) - -partially update the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1Workload - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedWorkload - - - -> V1alpha1Workload readNamespacedWorkload() - -read the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiReadNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiReadNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1Workload - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedWorkload - - - -> V1alpha1Workload replaceNamespacedWorkload(body) - -replace the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controllerRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - podGroups: [ - { - name: "name_example", - policy: { - basic: {}, - gang: { - minCount: 1, - }, - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1Workload**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1Workload - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/cluster/_category_.json b/website/docs/api-reference/cluster/_category_.json deleted file mode 100644 index 0cc46b9cf1e..00000000000 --- a/website/docs/api-reference/cluster/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Cluster", - "position": 6 -} diff --git a/website/docs/api-reference/configuration-storage/CoordinationApi.md b/website/docs/api-reference/configuration-storage/CoordinationApi.md deleted file mode 100644 index 80b8df4938e..00000000000 --- a/website/docs/api-reference/configuration-storage/CoordinationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: CoordinationApi -title: CoordinationApi -sidebar_label: CoordinationApi -sidebar_position: 1 ---- -# CoordinationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/configuration-storage/CoordinationApi#getAPIGroup) | **GET** /apis/coordination.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, CoordinationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/CoordinationV1Api.md b/website/docs/api-reference/configuration-storage/CoordinationV1Api.md deleted file mode 100644 index 9473e68ac7a..00000000000 --- a/website/docs/api-reference/configuration-storage/CoordinationV1Api.md +++ /dev/null @@ -1,835 +0,0 @@ ---- -id: CoordinationV1Api -title: CoordinationV1Api -sidebar_label: CoordinationV1Api -sidebar_position: 3 ---- -# CoordinationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#createNamespacedLease) | **POST** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**deleteCollectionNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#deleteCollectionNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**deleteNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#deleteNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1/ | -[**listLeaseForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1Api#listLeaseForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1/leases | -[**listNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#listNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**patchNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#patchNamespacedLease) | **PATCH** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**readNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#readNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**replaceNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#replaceNamespacedLease) | **PUT** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | - -### createNamespacedLease - - - -> V1Lease createNamespacedLease(body) - -create a Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiCreateNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiCreateNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - acquireTime: "acquireTime_example", - holderIdentity: "holderIdentity_example", - leaseDurationSeconds: 1, - leaseTransitions: 1, - preferredHolder: "preferredHolder_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Lease**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Lease - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedLease - - - -> V1Status deleteCollectionNamespacedLease() - -delete collection of Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedLease - - - -> V1Status deleteNamespacedLease() - -delete a Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiDeleteNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiDeleteNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listLeaseForAllNamespaces - - - -> V1LeaseList listLeaseForAllNamespaces() - -list or watch objects of kind Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiListLeaseForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiListLeaseForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1LeaseList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedLease - - - -> V1LeaseList listNamespacedLease() - -list or watch objects of kind Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiListNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiListNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1LeaseList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedLease - - - -> V1Lease patchNamespacedLease(body) - -partially update the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiPatchNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiPatchNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Lease - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedLease - - - -> V1Lease readNamespacedLease() - -read the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiReadNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiReadNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Lease - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedLease - - - -> V1Lease replaceNamespacedLease(body) - -replace the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiReplaceNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiReplaceNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - acquireTime: "acquireTime_example", - holderIdentity: "holderIdentity_example", - leaseDurationSeconds: 1, - leaseTransitions: 1, - preferredHolder: "preferredHolder_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Lease**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Lease - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/CoordinationV1alpha2Api.md b/website/docs/api-reference/configuration-storage/CoordinationV1alpha2Api.md deleted file mode 100644 index 28670d08afe..00000000000 --- a/website/docs/api-reference/configuration-storage/CoordinationV1alpha2Api.md +++ /dev/null @@ -1,833 +0,0 @@ ---- -id: CoordinationV1alpha2Api -title: CoordinationV1alpha2Api -sidebar_label: CoordinationV1alpha2Api -sidebar_position: 2 ---- -# CoordinationV1alpha2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**deleteCollectionNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**deleteNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1alpha2/ | -[**listLeaseCandidateForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1alpha2/leasecandidates | -[**listNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**patchNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**readNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**replaceNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | - -### createNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidate createNamespacedLeaseCandidate(body) - -create a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2LeaseCandidate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedLeaseCandidate - - - -> V1Status deleteCollectionNamespacedLeaseCandidate() - -delete collection of LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedLeaseCandidate - - - -> V1Status deleteNamespacedLeaseCandidate() - -delete a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listLeaseCandidateForAllNamespaces - - - -> V1alpha2LeaseCandidateList listLeaseCandidateForAllNamespaces() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidateList listNamespacedLeaseCandidate() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidate patchNamespacedLeaseCandidate(body) - -partially update the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidate readNamespacedLeaseCandidate() - -read the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidate replaceNamespacedLeaseCandidate(body) - -replace the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2LeaseCandidate**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/CoordinationV1beta1Api.md b/website/docs/api-reference/configuration-storage/CoordinationV1beta1Api.md deleted file mode 100644 index ae939c61b48..00000000000 --- a/website/docs/api-reference/configuration-storage/CoordinationV1beta1Api.md +++ /dev/null @@ -1,833 +0,0 @@ ---- -id: CoordinationV1beta1Api -title: CoordinationV1beta1Api -sidebar_label: CoordinationV1beta1Api -sidebar_position: 4 ---- -# CoordinationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**deleteCollectionNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**deleteNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1beta1/ | -[**listLeaseCandidateForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1beta1/leasecandidates | -[**listNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**patchNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**readNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**replaceNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | - -### createNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidate createNamespacedLeaseCandidate(body) - -create a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1LeaseCandidate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedLeaseCandidate - - - -> V1Status deleteCollectionNamespacedLeaseCandidate() - -delete collection of LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedLeaseCandidate - - - -> V1Status deleteNamespacedLeaseCandidate() - -delete a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listLeaseCandidateForAllNamespaces - - - -> V1beta1LeaseCandidateList listLeaseCandidateForAllNamespaces() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidateList listNamespacedLeaseCandidate() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidate patchNamespacedLeaseCandidate(body) - -partially update the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidate readNamespacedLeaseCandidate() - -read the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidate replaceNamespacedLeaseCandidate(body) - -replace the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1LeaseCandidate**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/PolicyApi.md b/website/docs/api-reference/configuration-storage/PolicyApi.md deleted file mode 100644 index 3dc65d31ce0..00000000000 --- a/website/docs/api-reference/configuration-storage/PolicyApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: PolicyApi -title: PolicyApi -sidebar_label: PolicyApi -sidebar_position: 5 ---- -# PolicyApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/configuration-storage/PolicyApi#getAPIGroup) | **GET** /apis/policy/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, PolicyApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/PolicyV1Api.md b/website/docs/api-reference/configuration-storage/PolicyV1Api.md deleted file mode 100644 index 57e052b9fb7..00000000000 --- a/website/docs/api-reference/configuration-storage/PolicyV1Api.md +++ /dev/null @@ -1,1191 +0,0 @@ ---- -id: PolicyV1Api -title: PolicyV1Api -sidebar_label: PolicyV1Api -sidebar_position: 6 ---- -# PolicyV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#createNamespacedPodDisruptionBudget) | **POST** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**deleteCollectionNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#deleteCollectionNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**deleteNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#deleteNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/PolicyV1Api#getAPIResources) | **GET** /apis/policy/v1/ | -[**listNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#listNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**listPodDisruptionBudgetForAllNamespaces**](/docs/api-reference/configuration-storage/PolicyV1Api#listPodDisruptionBudgetForAllNamespaces) | **GET** /apis/policy/v1/poddisruptionbudgets | -[**patchNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#patchNamespacedPodDisruptionBudget) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**patchNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#patchNamespacedPodDisruptionBudgetStatus) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | -[**readNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#readNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**readNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#readNamespacedPodDisruptionBudgetStatus) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | -[**replaceNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#replaceNamespacedPodDisruptionBudget) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**replaceNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#replaceNamespacedPodDisruptionBudgetStatus) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | - -### createNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudget createNamespacedPodDisruptionBudget(body) - -create a PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPodDisruptionBudget - - - -> V1Status deleteCollectionNamespacedPodDisruptionBudget() - -delete collection of PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedPodDisruptionBudget - - - -> V1Status deleteNamespacedPodDisruptionBudget() - -delete a PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudgetList listNamespacedPodDisruptionBudget() - -list or watch objects of kind PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiListNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiListNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudgetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPodDisruptionBudgetForAllNamespaces - - - -> V1PodDisruptionBudgetList listPodDisruptionBudgetForAllNamespaces() - -list or watch objects of kind PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodDisruptionBudgetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudgetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudget patchNamespacedPodDisruptionBudget(body) - -partially update the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodDisruptionBudgetStatus - - - -> V1PodDisruptionBudget patchNamespacedPodDisruptionBudgetStatus(body) - -partially update status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudget readNamespacedPodDisruptionBudget() - -read the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodDisruptionBudgetStatus - - - -> V1PodDisruptionBudget readNamespacedPodDisruptionBudgetStatus() - -read status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudget(body) - -replace the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodDisruptionBudgetStatus - - - -> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudgetStatus(body) - -replace status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/StorageApi.md b/website/docs/api-reference/configuration-storage/StorageApi.md deleted file mode 100644 index e5460e8bc7e..00000000000 --- a/website/docs/api-reference/configuration-storage/StorageApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: StorageApi -title: StorageApi -sidebar_label: StorageApi -sidebar_position: 7 ---- -# StorageApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/configuration-storage/StorageApi#getAPIGroup) | **GET** /apis/storage.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, StorageApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/StorageV1Api.md b/website/docs/api-reference/configuration-storage/StorageV1Api.md deleted file mode 100644 index 5a7b8715d3c..00000000000 --- a/website/docs/api-reference/configuration-storage/StorageV1Api.md +++ /dev/null @@ -1,5308 +0,0 @@ ---- -id: StorageV1Api -title: StorageV1Api -sidebar_label: StorageV1Api -sidebar_position: 10 ---- -# StorageV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#createCSIDriver) | **POST** /apis/storage.k8s.io/v1/csidrivers | -[**createCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#createCSINode) | **POST** /apis/storage.k8s.io/v1/csinodes | -[**createNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#createNamespacedCSIStorageCapacity) | **POST** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**createStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#createStorageClass) | **POST** /apis/storage.k8s.io/v1/storageclasses | -[**createVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#createVolumeAttachment) | **POST** /apis/storage.k8s.io/v1/volumeattachments | -[**createVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**deleteCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**deleteCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes/{name} | -[**deleteCollectionCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers | -[**deleteCollectionCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes | -[**deleteCollectionNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**deleteCollectionStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses | -[**deleteCollectionVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments | -[**deleteCollectionVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**deleteNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#deleteNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**deleteStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**deleteVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#deleteVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**deleteVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/StorageV1Api#getAPIResources) | **GET** /apis/storage.k8s.io/v1/ | -[**listCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#listCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers | -[**listCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#listCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes | -[**listCSIStorageCapacityForAllNamespaces**](/docs/api-reference/configuration-storage/StorageV1Api#listCSIStorageCapacityForAllNamespaces) | **GET** /apis/storage.k8s.io/v1/csistoragecapacities | -[**listNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#listNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**listStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#listStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses | -[**listVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#listVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments | -[**listVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**patchCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#patchCSIDriver) | **PATCH** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**patchCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#patchCSINode) | **PATCH** /apis/storage.k8s.io/v1/csinodes/{name} | -[**patchNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#patchNamespacedCSIStorageCapacity) | **PATCH** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**patchStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#patchStorageClass) | **PATCH** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**patchVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttachment) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**patchVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttachmentStatus) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**patchVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**readCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#readCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**readCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#readCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes/{name} | -[**readNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#readNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**readStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#readStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**readVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**readVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttachmentStatus) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**readVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**replaceCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#replaceCSIDriver) | **PUT** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**replaceCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#replaceCSINode) | **PUT** /apis/storage.k8s.io/v1/csinodes/{name} | -[**replaceNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#replaceNamespacedCSIStorageCapacity) | **PUT** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**replaceStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#replaceStorageClass) | **PUT** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**replaceVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttachment) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**replaceVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttachmentStatus) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**replaceVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | - -### createCSIDriver - - - -> V1CSIDriver createCSIDriver(body) - -create a CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateCSIDriverRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attachRequired: true, - fsGroupPolicy: "fsGroupPolicy_example", - nodeAllocatableUpdatePeriodSeconds: 1, - podInfoOnMount: true, - requiresRepublish: true, - seLinuxMount: true, - serviceAccountTokenInSecrets: true, - storageCapacity: true, - tokenRequests: [ - { - audience: "audience_example", - expirationSeconds: 1, - }, - ], - volumeLifecycleModes: [ - "volumeLifecycleModes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIDriver**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createCSINode - - - -> V1CSINode createCSINode(body) - -create a CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateCSINodeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - drivers: [ - { - allocatable: { - count: 1, - }, - name: "name_example", - nodeID: "nodeID_example", - topologyKeys: [ - "topologyKeys_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSINode**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacity createNamespacedCSIStorageCapacity(body) - -create a CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - capacity: "capacity_example", - kind: "kind_example", - maximumVolumeSize: "maximumVolumeSize_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - nodeTopology: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIStorageCapacity**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacity - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createStorageClass - - - -> V1StorageClass createStorageClass(body) - -create a StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateStorageClassRequest = { - - body: { - allowVolumeExpansion: true, - allowedTopologies: [ - { - matchLabelExpressions: [ - { - key: "key_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - mountOptions: [ - "mountOptions_example", - ], - parameters: { - "key": "key_example", - }, - provisioner: "provisioner_example", - reclaimPolicy: "reclaimPolicy_example", - volumeBindingMode: "volumeBindingMode_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StorageClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createVolumeAttachment - - - -> V1VolumeAttachment createVolumeAttachment(body) - -create a VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateVolumeAttachmentRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createVolumeAttributesClass - - - -> V1VolumeAttributesClass createVolumeAttributesClass(body) - -create a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateVolumeAttributesClassRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttributesClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCSIDriver - - - -> V1CSIDriver deleteCSIDriver() - -delete a CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCSINode - - - -> V1CSINode deleteCSINode() - -delete a CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCSINodeRequest = { - // name of the CSINode - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionCSIDriver - - - -> V1Status deleteCollectionCSIDriver() - -delete collection of CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionCSIDriverRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionCSINode - - - -> V1Status deleteCollectionCSINode() - -delete collection of CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionCSINodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedCSIStorageCapacity - - - -> V1Status deleteCollectionNamespacedCSIStorageCapacity() - -delete collection of CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionStorageClass - - - -> V1Status deleteCollectionStorageClass() - -delete collection of StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionStorageClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionVolumeAttachment - - - -> V1Status deleteCollectionVolumeAttachment() - -delete collection of VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionVolumeAttachmentRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionVolumeAttributesClass - - - -> V1Status deleteCollectionVolumeAttributesClass() - -delete collection of VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedCSIStorageCapacity - - - -> V1Status deleteNamespacedCSIStorageCapacity() - -delete a CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteStorageClass - - - -> V1StorageClass deleteStorageClass() - -delete a StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteStorageClassRequest = { - // name of the StorageClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteVolumeAttachment - - - -> V1VolumeAttachment deleteVolumeAttachment() - -delete a VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteVolumeAttributesClass - - - -> V1VolumeAttributesClass deleteVolumeAttributesClass() - -delete a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCSIDriver - - - -> V1CSIDriverList listCSIDriver() - -list or watch objects of kind CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSIDriverRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CSIDriverList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCSINode - - - -> V1CSINodeList listCSINode() - -list or watch objects of kind CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSINodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CSINodeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCSIStorageCapacityForAllNamespaces - - - -> V1CSIStorageCapacityList listCSIStorageCapacityForAllNamespaces() - -list or watch objects of kind CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSIStorageCapacityForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacityList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacityList listNamespacedCSIStorageCapacity() - -list or watch objects of kind CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacityList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listStorageClass - - - -> V1StorageClassList listStorageClass() - -list or watch objects of kind StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListStorageClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1StorageClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listVolumeAttachment - - - -> V1VolumeAttachmentList listVolumeAttachment() - -list or watch objects of kind VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListVolumeAttachmentRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachmentList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listVolumeAttributesClass - - - -> V1VolumeAttributesClassList listVolumeAttributesClass() - -list or watch objects of kind VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchCSIDriver - - - -> V1CSIDriver patchCSIDriver(body) - -partially update the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchCSINode - - - -> V1CSINode patchCSINode(body) - -partially update the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchCSINodeRequest = { - // name of the CSINode - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacity patchNamespacedCSIStorageCapacity(body) - -partially update the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacity - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchStorageClass - - - -> V1StorageClass patchStorageClass(body) - -partially update the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchStorageClassRequest = { - // name of the StorageClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchVolumeAttachment - - - -> V1VolumeAttachment patchVolumeAttachment(body) - -partially update the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchVolumeAttachmentStatus - - - -> V1VolumeAttachment patchVolumeAttachmentStatus(body) - -partially update status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchVolumeAttributesClass - - - -> V1VolumeAttributesClass patchVolumeAttributesClass(body) - -partially update the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readCSIDriver - - - -> V1CSIDriver readCSIDriver() - -read the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readCSINode - - - -> V1CSINode readCSINode() - -read the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadCSINodeRequest = { - // name of the CSINode - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacity readNamespacedCSIStorageCapacity() - -read the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacity - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readStorageClass - - - -> V1StorageClass readStorageClass() - -read the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadStorageClassRequest = { - // name of the StorageClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readVolumeAttachment - - - -> V1VolumeAttachment readVolumeAttachment() - -read the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readVolumeAttachmentStatus - - - -> V1VolumeAttachment readVolumeAttachmentStatus() - -read status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readVolumeAttributesClass - - - -> V1VolumeAttributesClass readVolumeAttributesClass() - -read the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceCSIDriver - - - -> V1CSIDriver replaceCSIDriver(body) - -replace the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attachRequired: true, - fsGroupPolicy: "fsGroupPolicy_example", - nodeAllocatableUpdatePeriodSeconds: 1, - podInfoOnMount: true, - requiresRepublish: true, - seLinuxMount: true, - serviceAccountTokenInSecrets: true, - storageCapacity: true, - tokenRequests: [ - { - audience: "audience_example", - expirationSeconds: 1, - }, - ], - volumeLifecycleModes: [ - "volumeLifecycleModes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIDriver**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceCSINode - - - -> V1CSINode replaceCSINode(body) - -replace the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceCSINodeRequest = { - // name of the CSINode - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - drivers: [ - { - allocatable: { - count: 1, - }, - name: "name_example", - nodeID: "nodeID_example", - topologyKeys: [ - "topologyKeys_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSINode**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacity replaceNamespacedCSIStorageCapacity(body) - -replace the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - capacity: "capacity_example", - kind: "kind_example", - maximumVolumeSize: "maximumVolumeSize_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - nodeTopology: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIStorageCapacity**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacity - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceStorageClass - - - -> V1StorageClass replaceStorageClass(body) - -replace the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceStorageClassRequest = { - // name of the StorageClass - name: "name_example", - - body: { - allowVolumeExpansion: true, - allowedTopologies: [ - { - matchLabelExpressions: [ - { - key: "key_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - mountOptions: [ - "mountOptions_example", - ], - parameters: { - "key": "key_example", - }, - provisioner: "provisioner_example", - reclaimPolicy: "reclaimPolicy_example", - volumeBindingMode: "volumeBindingMode_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StorageClass**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceVolumeAttachment - - - -> V1VolumeAttachment replaceVolumeAttachment(body) - -replace the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceVolumeAttachmentStatus - - - -> V1VolumeAttachment replaceVolumeAttachmentStatus(body) - -replace status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceVolumeAttributesClass - - - -> V1VolumeAttributesClass replaceVolumeAttributesClass(body) - -replace the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttributesClass**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/StorageV1beta1Api.md b/website/docs/api-reference/configuration-storage/StorageV1beta1Api.md deleted file mode 100644 index f868ee6bae8..00000000000 --- a/website/docs/api-reference/configuration-storage/StorageV1beta1Api.md +++ /dev/null @@ -1,719 +0,0 @@ ---- -id: StorageV1beta1Api -title: StorageV1beta1Api -sidebar_label: StorageV1beta1Api -sidebar_position: 11 ---- -# StorageV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**deleteCollectionVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**deleteVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/StorageV1beta1Api#getAPIResources) | **GET** /apis/storage.k8s.io/v1beta1/ | -[**listVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**patchVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**readVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**replaceVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | - -### createVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass createVolumeAttributesClass(body) - -create a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiCreateVolumeAttributesClassRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1VolumeAttributesClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionVolumeAttributesClass - - - -> V1Status deleteCollectionVolumeAttributesClass() - -delete collection of VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass deleteVolumeAttributesClass() - -delete a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiDeleteVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listVolumeAttributesClass - - - -> V1beta1VolumeAttributesClassList listVolumeAttributesClass() - -list or watch objects of kind VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiListVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass patchVolumeAttributesClass(body) - -partially update the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiPatchVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass readVolumeAttributesClass() - -read the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiReadVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass replaceVolumeAttributesClass(body) - -replace the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiReplaceVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1VolumeAttributesClass**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/StoragemigrationApi.md b/website/docs/api-reference/configuration-storage/StoragemigrationApi.md deleted file mode 100644 index c5297ac8c14..00000000000 --- a/website/docs/api-reference/configuration-storage/StoragemigrationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: StoragemigrationApi -title: StoragemigrationApi -sidebar_label: StoragemigrationApi -sidebar_position: 8 ---- -# StoragemigrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/configuration-storage/StoragemigrationApi#getAPIGroup) | **GET** /apis/storagemigration.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, StoragemigrationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api.md b/website/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api.md deleted file mode 100644 index 00238d62246..00000000000 --- a/website/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api.md +++ /dev/null @@ -1,1016 +0,0 @@ ---- -id: StoragemigrationV1beta1Api -title: StoragemigrationV1beta1Api -sidebar_label: StoragemigrationV1beta1Api -sidebar_position: 9 ---- -# StoragemigrationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#createStorageVersionMigration) | **POST** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**deleteCollectionStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#deleteCollectionStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**deleteStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#deleteStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#getAPIResources) | **GET** /apis/storagemigration.k8s.io/v1beta1/ | -[**listStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#listStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**patchStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#patchStorageVersionMigration) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**patchStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#patchStorageVersionMigrationStatus) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | -[**readStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#readStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**readStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#readStorageVersionMigrationStatus) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | -[**replaceStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#replaceStorageVersionMigration) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**replaceStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#replaceStorageVersionMigrationStatus) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | - -### createStorageVersionMigration - - - -> V1beta1StorageVersionMigration createStorageVersionMigration(body) - -create a StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionStorageVersionMigration - - - -> V1Status deleteCollectionStorageVersionMigration() - -delete collection of StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteStorageVersionMigration - - - -> V1Status deleteStorageVersionMigration() - -delete a StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listStorageVersionMigration - - - -> V1beta1StorageVersionMigrationList listStorageVersionMigration() - -list or watch objects of kind StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiListStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiListStorageVersionMigrationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigrationList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchStorageVersionMigration - - - -> V1beta1StorageVersionMigration patchStorageVersionMigration(body) - -partially update the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchStorageVersionMigrationStatus - - - -> V1beta1StorageVersionMigration patchStorageVersionMigrationStatus(body) - -partially update status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readStorageVersionMigration - - - -> V1beta1StorageVersionMigration readStorageVersionMigration() - -read the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readStorageVersionMigrationStatus - - - -> V1beta1StorageVersionMigration readStorageVersionMigrationStatus() - -read status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceStorageVersionMigration - - - -> V1beta1StorageVersionMigration replaceStorageVersionMigration(body) - -replace the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceStorageVersionMigrationStatus - - - -> V1beta1StorageVersionMigration replaceStorageVersionMigrationStatus(body) - -replace status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/configuration-storage/_category_.json b/website/docs/api-reference/configuration-storage/_category_.json deleted file mode 100644 index 6723fe67c06..00000000000 --- a/website/docs/api-reference/configuration-storage/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Configuration & Storage", - "position": 5 -} diff --git a/website/docs/api-reference/core-resources/CoreApi.md b/website/docs/api-reference/core-resources/CoreApi.md deleted file mode 100644 index 23689cf7d5a..00000000000 --- a/website/docs/api-reference/core-resources/CoreApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: CoreApi -title: CoreApi -sidebar_label: CoreApi -sidebar_position: 1 ---- -# CoreApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIVersions**](/docs/api-reference/core-resources/CoreApi#getAPIVersions) | **GET** /api/ | - -### getAPIVersions - - - -> V1APIVersions getAPIVersions() - -get available API versions - -### Example - - -```typescript -import { createConfiguration, CoreApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIVersions(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIVersions - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/core-resources/CoreV1Api.md b/website/docs/api-reference/core-resources/CoreV1Api.md deleted file mode 100644 index 13ef8d9adec..00000000000 --- a/website/docs/api-reference/core-resources/CoreV1Api.md +++ /dev/null @@ -1,39221 +0,0 @@ ---- -id: CoreV1Api -title: CoreV1Api -sidebar_label: CoreV1Api -sidebar_position: 2 ---- -# CoreV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**connectDeleteNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedPodProxy) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectDeleteNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedPodProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectDeleteNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedServiceProxy) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectDeleteNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedServiceProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectDeleteNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNodeProxy) | **DELETE** /api/v1/nodes/{name}/proxy | -[**connectDeleteNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNodeProxyWithPath) | **DELETE** /api/v1/nodes/{name}/proxy/{path} | -[**connectGetNamespacedPodAttach**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodAttach) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/attach | -[**connectGetNamespacedPodExec**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodExec) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/exec | -[**connectGetNamespacedPodPortforward**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodPortforward) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/portforward | -[**connectGetNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodProxy) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectGetNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectGetNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedServiceProxy) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectGetNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedServiceProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectGetNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNodeProxy) | **GET** /api/v1/nodes/{name}/proxy | -[**connectGetNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNodeProxyWithPath) | **GET** /api/v1/nodes/{name}/proxy/{path} | -[**connectHeadNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedPodProxy) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectHeadNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedPodProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectHeadNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedServiceProxy) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectHeadNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedServiceProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectHeadNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNodeProxy) | **HEAD** /api/v1/nodes/{name}/proxy | -[**connectHeadNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNodeProxyWithPath) | **HEAD** /api/v1/nodes/{name}/proxy/{path} | -[**connectOptionsNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedPodProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectOptionsNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedPodProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectOptionsNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedServiceProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectOptionsNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedServiceProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectOptionsNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNodeProxy) | **OPTIONS** /api/v1/nodes/{name}/proxy | -[**connectOptionsNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNodeProxyWithPath) | **OPTIONS** /api/v1/nodes/{name}/proxy/{path} | -[**connectPatchNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedPodProxy) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPatchNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedPodProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPatchNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedServiceProxy) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPatchNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedServiceProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPatchNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNodeProxy) | **PATCH** /api/v1/nodes/{name}/proxy | -[**connectPatchNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNodeProxyWithPath) | **PATCH** /api/v1/nodes/{name}/proxy/{path} | -[**connectPostNamespacedPodAttach**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodAttach) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/attach | -[**connectPostNamespacedPodExec**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodExec) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/exec | -[**connectPostNamespacedPodPortforward**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodPortforward) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/portforward | -[**connectPostNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodProxy) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPostNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPostNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedServiceProxy) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPostNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedServiceProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPostNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNodeProxy) | **POST** /api/v1/nodes/{name}/proxy | -[**connectPostNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNodeProxyWithPath) | **POST** /api/v1/nodes/{name}/proxy/{path} | -[**connectPutNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedPodProxy) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPutNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedPodProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPutNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedServiceProxy) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPutNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedServiceProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPutNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNodeProxy) | **PUT** /api/v1/nodes/{name}/proxy | -[**connectPutNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNodeProxyWithPath) | **PUT** /api/v1/nodes/{name}/proxy/{path} | -[**createNamespace**](/docs/api-reference/core-resources/CoreV1Api#createNamespace) | **POST** /api/v1/namespaces | -[**createNamespacedBinding**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedBinding) | **POST** /api/v1/namespaces/{namespace}/bindings | -[**createNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedConfigMap) | **POST** /api/v1/namespaces/{namespace}/configmaps | -[**createNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedEndpoints) | **POST** /api/v1/namespaces/{namespace}/endpoints | -[**createNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedEvent) | **POST** /api/v1/namespaces/{namespace}/events | -[**createNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedLimitRange) | **POST** /api/v1/namespaces/{namespace}/limitranges | -[**createNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPersistentVolumeClaim) | **POST** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**createNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPod) | **POST** /api/v1/namespaces/{namespace}/pods | -[**createNamespacedPodBinding**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodBinding) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/binding | -[**createNamespacedPodEviction**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodEviction) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/eviction | -[**createNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodTemplate) | **POST** /api/v1/namespaces/{namespace}/podtemplates | -[**createNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedReplicationController) | **POST** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**createNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedResourceQuota) | **POST** /api/v1/namespaces/{namespace}/resourcequotas | -[**createNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedSecret) | **POST** /api/v1/namespaces/{namespace}/secrets | -[**createNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedService) | **POST** /api/v1/namespaces/{namespace}/services | -[**createNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedServiceAccount) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts | -[**createNamespacedServiceAccountToken**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedServiceAccountToken) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token | -[**createNode**](/docs/api-reference/core-resources/CoreV1Api#createNode) | **POST** /api/v1/nodes | -[**createPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#createPersistentVolume) | **POST** /api/v1/persistentvolumes | -[**deleteCollectionNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps | -[**deleteCollectionNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints | -[**deleteCollectionNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events | -[**deleteCollectionNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges | -[**deleteCollectionNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**deleteCollectionNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods | -[**deleteCollectionNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates | -[**deleteCollectionNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**deleteCollectionNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas | -[**deleteCollectionNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets | -[**deleteCollectionNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services | -[**deleteCollectionNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts | -[**deleteCollectionNode**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNode) | **DELETE** /api/v1/nodes | -[**deleteCollectionPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionPersistentVolume) | **DELETE** /api/v1/persistentvolumes | -[**deleteNamespace**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespace) | **DELETE** /api/v1/namespaces/{name} | -[**deleteNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**deleteNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**deleteNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events/{name} | -[**deleteNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**deleteNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**deleteNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name} | -[**deleteNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**deleteNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**deleteNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**deleteNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets/{name} | -[**deleteNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services/{name} | -[**deleteNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**deleteNode**](/docs/api-reference/core-resources/CoreV1Api#deleteNode) | **DELETE** /api/v1/nodes/{name} | -[**deletePersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#deletePersistentVolume) | **DELETE** /api/v1/persistentvolumes/{name} | -[**getAPIResources**](/docs/api-reference/core-resources/CoreV1Api#getAPIResources) | **GET** /api/v1/ | -[**listComponentStatus**](/docs/api-reference/core-resources/CoreV1Api#listComponentStatus) | **GET** /api/v1/componentstatuses | -[**listConfigMapForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listConfigMapForAllNamespaces) | **GET** /api/v1/configmaps | -[**listEndpointsForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listEndpointsForAllNamespaces) | **GET** /api/v1/endpoints | -[**listEventForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listEventForAllNamespaces) | **GET** /api/v1/events | -[**listLimitRangeForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listLimitRangeForAllNamespaces) | **GET** /api/v1/limitranges | -[**listNamespace**](/docs/api-reference/core-resources/CoreV1Api#listNamespace) | **GET** /api/v1/namespaces | -[**listNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps | -[**listNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints | -[**listNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events | -[**listNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges | -[**listNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**listNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods | -[**listNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates | -[**listNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**listNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas | -[**listNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets | -[**listNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services | -[**listNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts | -[**listNode**](/docs/api-reference/core-resources/CoreV1Api#listNode) | **GET** /api/v1/nodes | -[**listPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#listPersistentVolume) | **GET** /api/v1/persistentvolumes | -[**listPersistentVolumeClaimForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPersistentVolumeClaimForAllNamespaces) | **GET** /api/v1/persistentvolumeclaims | -[**listPodForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPodForAllNamespaces) | **GET** /api/v1/pods | -[**listPodTemplateForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPodTemplateForAllNamespaces) | **GET** /api/v1/podtemplates | -[**listReplicationControllerForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listReplicationControllerForAllNamespaces) | **GET** /api/v1/replicationcontrollers | -[**listResourceQuotaForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listResourceQuotaForAllNamespaces) | **GET** /api/v1/resourcequotas | -[**listSecretForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listSecretForAllNamespaces) | **GET** /api/v1/secrets | -[**listServiceAccountForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listServiceAccountForAllNamespaces) | **GET** /api/v1/serviceaccounts | -[**listServiceForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listServiceForAllNamespaces) | **GET** /api/v1/services | -[**patchNamespace**](/docs/api-reference/core-resources/CoreV1Api#patchNamespace) | **PATCH** /api/v1/namespaces/{name} | -[**patchNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespaceStatus) | **PATCH** /api/v1/namespaces/{name}/status | -[**patchNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedConfigMap) | **PATCH** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**patchNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedEndpoints) | **PATCH** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**patchNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedEvent) | **PATCH** /api/v1/namespaces/{namespace}/events/{name} | -[**patchNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedLimitRange) | **PATCH** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**patchNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPersistentVolumeClaim) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**patchNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPersistentVolumeClaimStatus) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**patchNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPod) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name} | -[**patchNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodEphemeralcontainers) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**patchNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodResize) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**patchNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodStatus) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**patchNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodTemplate) | **PATCH** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**patchNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationController) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**patchNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationControllerScale) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**patchNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationControllerStatus) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**patchNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedResourceQuota) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**patchNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedResourceQuotaStatus) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**patchNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedSecret) | **PATCH** /api/v1/namespaces/{namespace}/secrets/{name} | -[**patchNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedService) | **PATCH** /api/v1/namespaces/{namespace}/services/{name} | -[**patchNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedServiceAccount) | **PATCH** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**patchNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedServiceStatus) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/status | -[**patchNode**](/docs/api-reference/core-resources/CoreV1Api#patchNode) | **PATCH** /api/v1/nodes/{name} | -[**patchNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNodeStatus) | **PATCH** /api/v1/nodes/{name}/status | -[**patchPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#patchPersistentVolume) | **PATCH** /api/v1/persistentvolumes/{name} | -[**patchPersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#patchPersistentVolumeStatus) | **PATCH** /api/v1/persistentvolumes/{name}/status | -[**readComponentStatus**](/docs/api-reference/core-resources/CoreV1Api#readComponentStatus) | **GET** /api/v1/componentstatuses/{name} | -[**readNamespace**](/docs/api-reference/core-resources/CoreV1Api#readNamespace) | **GET** /api/v1/namespaces/{name} | -[**readNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespaceStatus) | **GET** /api/v1/namespaces/{name}/status | -[**readNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**readNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**readNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events/{name} | -[**readNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**readNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**readNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPersistentVolumeClaimStatus) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**readNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods/{name} | -[**readNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodEphemeralcontainers) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**readNamespacedPodLog**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodLog) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/log | -[**readNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodResize) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**readNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodStatus) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**readNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**readNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**readNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationControllerScale) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**readNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationControllerStatus) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**readNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**readNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedResourceQuotaStatus) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**readNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets/{name} | -[**readNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services/{name} | -[**readNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**readNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedServiceStatus) | **GET** /api/v1/namespaces/{namespace}/services/{name}/status | -[**readNode**](/docs/api-reference/core-resources/CoreV1Api#readNode) | **GET** /api/v1/nodes/{name} | -[**readNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#readNodeStatus) | **GET** /api/v1/nodes/{name}/status | -[**readPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#readPersistentVolume) | **GET** /api/v1/persistentvolumes/{name} | -[**readPersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#readPersistentVolumeStatus) | **GET** /api/v1/persistentvolumes/{name}/status | -[**replaceNamespace**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespace) | **PUT** /api/v1/namespaces/{name} | -[**replaceNamespaceFinalize**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespaceFinalize) | **PUT** /api/v1/namespaces/{name}/finalize | -[**replaceNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespaceStatus) | **PUT** /api/v1/namespaces/{name}/status | -[**replaceNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedConfigMap) | **PUT** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**replaceNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedEndpoints) | **PUT** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**replaceNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedEvent) | **PUT** /api/v1/namespaces/{namespace}/events/{name} | -[**replaceNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedLimitRange) | **PUT** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**replaceNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPersistentVolumeClaim) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**replaceNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPersistentVolumeClaimStatus) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**replaceNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPod) | **PUT** /api/v1/namespaces/{namespace}/pods/{name} | -[**replaceNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodEphemeralcontainers) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**replaceNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodResize) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**replaceNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodStatus) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**replaceNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodTemplate) | **PUT** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**replaceNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationController) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**replaceNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationControllerScale) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**replaceNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationControllerStatus) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**replaceNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedResourceQuota) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**replaceNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedResourceQuotaStatus) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**replaceNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedSecret) | **PUT** /api/v1/namespaces/{namespace}/secrets/{name} | -[**replaceNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedService) | **PUT** /api/v1/namespaces/{namespace}/services/{name} | -[**replaceNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedServiceAccount) | **PUT** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**replaceNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedServiceStatus) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/status | -[**replaceNode**](/docs/api-reference/core-resources/CoreV1Api#replaceNode) | **PUT** /api/v1/nodes/{name} | -[**replaceNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNodeStatus) | **PUT** /api/v1/nodes/{name}/status | -[**replacePersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#replacePersistentVolume) | **PUT** /api/v1/persistentvolumes/{name} | -[**replacePersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#replacePersistentVolumeStatus) | **PUT** /api/v1/persistentvolumes/{name}/status | - -### connectDeleteNamespacedPodProxy - - - -> string connectDeleteNamespacedPodProxy() - -connect DELETE requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNamespacedPodProxyWithPath - - - -> string connectDeleteNamespacedPodProxyWithPath() - -connect DELETE requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNamespacedServiceProxy - - - -> string connectDeleteNamespacedServiceProxy() - -connect DELETE requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNamespacedServiceProxyWithPath - - - -> string connectDeleteNamespacedServiceProxyWithPath() - -connect DELETE requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNodeProxy - - - -> string connectDeleteNodeProxy() - -connect DELETE requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNodeProxyWithPath - - - -> string connectDeleteNodeProxyWithPath() - -connect DELETE requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodAttach - - - -> string connectGetNamespacedPodAttach() - -connect GET requests to attach of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodAttachRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodAttachRequest = { - // name of the PodAttachOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) - stderr: true, - // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectGetNamespacedPodAttach(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodAttachOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodExec - - - -> string connectGetNamespacedPodExec() - -connect GET requests to exec of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodExecRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodExecRequest = { - // name of the PodExecOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Command is the remote command to execute. argv array. Not executed within a shell. (optional) - command: "command_example", - // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Redirect the standard error stream of the pod for this call. (optional) - stderr: true, - // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Redirect the standard output stream of the pod for this call. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectGetNamespacedPodExec(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodExecOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined - **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined - **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodPortforward - - - -> string connectGetNamespacedPodPortforward() - -connect GET requests to portforward of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodPortforwardRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodPortforwardRequest = { - // name of the PodPortForwardOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // List of ports to forward Required when using WebSockets (optional) - ports: 1, -}; - -const data = await apiInstance.connectGetNamespacedPodPortforward(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodProxy - - - -> string connectGetNamespacedPodProxy() - -connect GET requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodProxyWithPath - - - -> string connectGetNamespacedPodProxyWithPath() - -connect GET requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedServiceProxy - - - -> string connectGetNamespacedServiceProxy() - -connect GET requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedServiceProxyWithPath - - - -> string connectGetNamespacedServiceProxyWithPath() - -connect GET requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNodeProxy - - - -> string connectGetNodeProxy() - -connect GET requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNodeProxyWithPath - - - -> string connectGetNodeProxyWithPath() - -connect GET requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNamespacedPodProxy - - - -> string connectHeadNamespacedPodProxy() - -connect HEAD requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNamespacedPodProxyWithPath - - - -> string connectHeadNamespacedPodProxyWithPath() - -connect HEAD requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNamespacedServiceProxy - - - -> string connectHeadNamespacedServiceProxy() - -connect HEAD requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNamespacedServiceProxyWithPath - - - -> string connectHeadNamespacedServiceProxyWithPath() - -connect HEAD requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNodeProxy - - - -> string connectHeadNodeProxy() - -connect HEAD requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNodeProxyWithPath - - - -> string connectHeadNodeProxyWithPath() - -connect HEAD requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNamespacedPodProxy - - - -> string connectOptionsNamespacedPodProxy() - -connect OPTIONS requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNamespacedPodProxyWithPath - - - -> string connectOptionsNamespacedPodProxyWithPath() - -connect OPTIONS requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNamespacedServiceProxy - - - -> string connectOptionsNamespacedServiceProxy() - -connect OPTIONS requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNamespacedServiceProxyWithPath - - - -> string connectOptionsNamespacedServiceProxyWithPath() - -connect OPTIONS requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNodeProxy - - - -> string connectOptionsNodeProxy() - -connect OPTIONS requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNodeProxyWithPath - - - -> string connectOptionsNodeProxyWithPath() - -connect OPTIONS requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNamespacedPodProxy - - - -> string connectPatchNamespacedPodProxy() - -connect PATCH requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNamespacedPodProxyWithPath - - - -> string connectPatchNamespacedPodProxyWithPath() - -connect PATCH requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNamespacedServiceProxy - - - -> string connectPatchNamespacedServiceProxy() - -connect PATCH requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNamespacedServiceProxyWithPath - - - -> string connectPatchNamespacedServiceProxyWithPath() - -connect PATCH requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNodeProxy - - - -> string connectPatchNodeProxy() - -connect PATCH requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNodeProxyWithPath - - - -> string connectPatchNodeProxyWithPath() - -connect PATCH requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodAttach - - - -> string connectPostNamespacedPodAttach() - -connect POST requests to attach of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodAttachRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodAttachRequest = { - // name of the PodAttachOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) - stderr: true, - // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectPostNamespacedPodAttach(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodAttachOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodExec - - - -> string connectPostNamespacedPodExec() - -connect POST requests to exec of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodExecRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodExecRequest = { - // name of the PodExecOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Command is the remote command to execute. argv array. Not executed within a shell. (optional) - command: "command_example", - // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Redirect the standard error stream of the pod for this call. (optional) - stderr: true, - // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Redirect the standard output stream of the pod for this call. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectPostNamespacedPodExec(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodExecOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined - **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined - **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodPortforward - - - -> string connectPostNamespacedPodPortforward() - -connect POST requests to portforward of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodPortforwardRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodPortforwardRequest = { - // name of the PodPortForwardOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // List of ports to forward Required when using WebSockets (optional) - ports: 1, -}; - -const data = await apiInstance.connectPostNamespacedPodPortforward(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodProxy - - - -> string connectPostNamespacedPodProxy() - -connect POST requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodProxyWithPath - - - -> string connectPostNamespacedPodProxyWithPath() - -connect POST requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedServiceProxy - - - -> string connectPostNamespacedServiceProxy() - -connect POST requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedServiceProxyWithPath - - - -> string connectPostNamespacedServiceProxyWithPath() - -connect POST requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNodeProxy - - - -> string connectPostNodeProxy() - -connect POST requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNodeProxyWithPath - - - -> string connectPostNodeProxyWithPath() - -connect POST requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNamespacedPodProxy - - - -> string connectPutNamespacedPodProxy() - -connect PUT requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNamespacedPodProxyWithPath - - - -> string connectPutNamespacedPodProxyWithPath() - -connect PUT requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNamespacedServiceProxy - - - -> string connectPutNamespacedServiceProxy() - -connect PUT requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNamespacedServiceProxyWithPath - - - -> string connectPutNamespacedServiceProxyWithPath() - -connect PUT requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNodeProxy - - - -> string connectPutNodeProxy() - -connect PUT requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNodeProxyWithPath - - - -> string connectPutNodeProxyWithPath() - -connect PUT requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### createNamespace - - - -> V1Namespace createNamespace(body) - -create a Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespaceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedBinding - - - -> V1Binding createNamespacedBinding(body) - -create a Binding - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - target: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Binding**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Binding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedConfigMap - - - -> V1ConfigMap createNamespacedConfigMap(body) - -create a ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - binaryData: { - "key": 'YQ==', - }, - data: { - "key": "key_example", - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ConfigMap**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ConfigMap - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedEndpoints - - - -> V1Endpoints createNamespacedEndpoints(body) - -create Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - subsets: [ - { - addresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - notReadyAddresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Endpoints**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Endpoints - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedEvent - - - -> CoreV1Event createNamespacedEvent(body) - -create an Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - count: 1, - eventTime: "eventTime_example", - firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - involvedObject: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - kind: "kind_example", - lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - reason: "reason_example", - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingComponent: "reportingComponent_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - source: { - component: "component_example", - host: "host_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **CoreV1Event**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -CoreV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedLimitRange - - - -> V1LimitRange createNamespacedLimitRange(body) - -create a LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - limits: [ - { - _default: { - "key": "key_example", - }, - defaultRequest: { - "key": "key_example", - }, - max: { - "key": "key_example", - }, - maxLimitRequestRatio: { - "key": "key_example", - }, - min: { - "key": "key_example", - }, - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LimitRange**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1LimitRange - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim createNamespacedPersistentVolumeClaim(body) - -create a PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPod - - - -> V1Pod createNamespacedPod(body) - -create a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPodBinding - - - -> V1Binding createNamespacedPodBinding(body) - -create binding of a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPodBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodBindingRequest = { - // name of the Binding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - target: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedPodBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Binding**| | - **name** | [**string**] | name of the Binding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Binding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPodEviction - - - -> V1Eviction createNamespacedPodEviction(body) - -create eviction of a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPodEvictionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodEvictionRequest = { - // name of the Eviction - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - deleteOptions: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedPodEviction(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Eviction**| | - **name** | [**string**] | name of the Eviction | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Eviction - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPodTemplate - - - -> V1PodTemplate createNamespacedPodTemplate(body) - -create a PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedReplicationController - - - -> V1ReplicationController createNamespacedReplicationController(body) - -create a ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceQuota - - - -> V1ResourceQuota createNamespacedResourceQuota(body) - -create a ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedSecret - - - -> V1Secret createNamespacedSecret(body) - -create a Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: { - "key": 'YQ==', - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - stringData: { - "key": "key_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Secret**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Secret - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedService - - - -> V1Service createNamespacedService(body) - -create a Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedServiceAccount - - - -> V1ServiceAccount createNamespacedServiceAccount(body) - -create a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - automountServiceAccountToken: true, - imagePullSecrets: [ - { - name: "name_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - secrets: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceAccount**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedServiceAccountToken - - - -> AuthenticationV1TokenRequest createNamespacedServiceAccountToken(body) - -create token of a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedServiceAccountTokenRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceAccountTokenRequest = { - // name of the TokenRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - audiences: [ - "audiences_example", - ], - boundObjectRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - expirationSeconds: 1, - }, - status: { - expirationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - token: "token_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedServiceAccountToken(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **AuthenticationV1TokenRequest**| | - **name** | [**string**] | name of the TokenRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -AuthenticationV1TokenRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNode - - - -> V1Node createNode(body) - -create a Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNodeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createPersistentVolume - - - -> V1PersistentVolume createPersistentVolume(body) - -create a PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreatePersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreatePersistentVolumeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedConfigMap - - - -> V1Status deleteCollectionNamespacedConfigMap() - -delete collection of ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedEndpoints - - - -> V1Status deleteCollectionNamespacedEndpoints() - -delete collection of Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedEvent - - - -> V1Status deleteCollectionNamespacedEvent() - -delete collection of Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedLimitRange - - - -> V1Status deleteCollectionNamespacedLimitRange() - -delete collection of LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPersistentVolumeClaim - - - -> V1Status deleteCollectionNamespacedPersistentVolumeClaim() - -delete collection of PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPod - - - -> V1Status deleteCollectionNamespacedPod() - -delete collection of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPodTemplate - - - -> V1Status deleteCollectionNamespacedPodTemplate() - -delete collection of PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedReplicationController - - - -> V1Status deleteCollectionNamespacedReplicationController() - -delete collection of ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceQuota - - - -> V1Status deleteCollectionNamespacedResourceQuota() - -delete collection of ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedSecret - - - -> V1Status deleteCollectionNamespacedSecret() - -delete collection of Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedService - - - -> V1Status deleteCollectionNamespacedService() - -delete collection of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedServiceAccount - - - -> V1Status deleteCollectionNamespacedServiceAccount() - -delete collection of ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNode - - - -> V1Status deleteCollectionNode() - -delete collection of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionPersistentVolume - - - -> V1Status deleteCollectionPersistentVolume() - -delete collection of PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionPersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionPersistentVolumeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespace - - - -> V1Status deleteNamespace() - -delete a Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespaceRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedConfigMap - - - -> V1Status deleteNamespacedConfigMap() - -delete a ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedEndpoints - - - -> V1Status deleteNamespacedEndpoints() - -delete Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedEvent - - - -> V1Status deleteNamespacedEvent() - -delete an Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedLimitRange - - - -> V1Status deleteNamespacedLimitRange() - -delete a LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim deleteNamespacedPersistentVolumeClaim() - -delete a PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedPod - - - -> V1Pod deleteNamespacedPod() - -delete a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedPodTemplate - - - -> V1PodTemplate deleteNamespacedPodTemplate() - -delete a PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedReplicationController - - - -> V1Status deleteNamespacedReplicationController() - -delete a ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceQuota - - - -> V1ResourceQuota deleteNamespacedResourceQuota() - -delete a ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedSecret - - - -> V1Status deleteNamespacedSecret() - -delete a Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedService - - - -> V1Service deleteNamespacedService() - -delete a Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedServiceAccount - - - -> V1ServiceAccount deleteNamespacedServiceAccount() - -delete a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNode - - - -> V1Status deleteNode() - -delete a Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNodeRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deletePersistentVolume - - - -> V1PersistentVolume deletePersistentVolume() - -delete a PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeletePersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeletePersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listComponentStatus - - - -> V1ComponentStatusList listComponentStatus() - -list objects of kind ComponentStatus - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListComponentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListComponentStatusRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listComponentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ComponentStatusList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listConfigMapForAllNamespaces - - - -> V1ConfigMapList listConfigMapForAllNamespaces() - -list or watch objects of kind ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListConfigMapForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListConfigMapForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listConfigMapForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ConfigMapList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listEndpointsForAllNamespaces - - - -> V1EndpointsList listEndpointsForAllNamespaces() - -list or watch objects of kind Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListEndpointsForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListEndpointsForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEndpointsForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1EndpointsList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listEventForAllNamespaces - - - -> CoreV1EventList listEventForAllNamespaces() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListEventForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListEventForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEventForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -CoreV1EventList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listLimitRangeForAllNamespaces - - - -> V1LimitRangeList listLimitRangeForAllNamespaces() - -list or watch objects of kind LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListLimitRangeForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListLimitRangeForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLimitRangeForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1LimitRangeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespace - - - -> V1NamespaceList listNamespace() - -list or watch objects of kind Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespaceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1NamespaceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedConfigMap - - - -> V1ConfigMapList listNamespacedConfigMap() - -list or watch objects of kind ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ConfigMapList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedEndpoints - - - -> V1EndpointsList listNamespacedEndpoints() - -list or watch objects of kind Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1EndpointsList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedEvent - - - -> CoreV1EventList listNamespacedEvent() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -CoreV1EventList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedLimitRange - - - -> V1LimitRangeList listNamespacedLimitRange() - -list or watch objects of kind LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1LimitRangeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaimList listNamespacedPersistentVolumeClaim() - -list or watch objects of kind PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPod - - - -> V1PodList listNamespacedPod() - -list or watch objects of kind Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPodTemplate - - - -> V1PodTemplateList listNamespacedPodTemplate() - -list or watch objects of kind PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedReplicationController - - - -> V1ReplicationControllerList listNamespacedReplicationController() - -list or watch objects of kind ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ReplicationControllerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceQuota - - - -> V1ResourceQuotaList listNamespacedResourceQuota() - -list or watch objects of kind ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceQuotaList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedSecret - - - -> V1SecretList listNamespacedSecret() - -list or watch objects of kind Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1SecretList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedService - - - -> V1ServiceList listNamespacedService() - -list or watch objects of kind Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedServiceAccount - - - -> V1ServiceAccountList listNamespacedServiceAccount() - -list or watch objects of kind ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceAccountList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNode - - - -> V1NodeList listNode() - -list or watch objects of kind Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1NodeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPersistentVolume - - - -> V1PersistentVolumeList listPersistentVolume() - -list or watch objects of kind PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListPersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPersistentVolumeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPersistentVolumeClaimForAllNamespaces - - - -> V1PersistentVolumeClaimList listPersistentVolumeClaimForAllNamespaces() - -list or watch objects of kind PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPersistentVolumeClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPodForAllNamespaces - - - -> V1PodList listPodForAllNamespaces() - -list or watch objects of kind Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListPodForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPodForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPodTemplateForAllNamespaces - - - -> V1PodTemplateList listPodTemplateForAllNamespaces() - -list or watch objects of kind PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListPodTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPodTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listReplicationControllerForAllNamespaces - - - -> V1ReplicationControllerList listReplicationControllerForAllNamespaces() - -list or watch objects of kind ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListReplicationControllerForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListReplicationControllerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listReplicationControllerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ReplicationControllerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceQuotaForAllNamespaces - - - -> V1ResourceQuotaList listResourceQuotaForAllNamespaces() - -list or watch objects of kind ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListResourceQuotaForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListResourceQuotaForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceQuotaForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceQuotaList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listSecretForAllNamespaces - - - -> V1SecretList listSecretForAllNamespaces() - -list or watch objects of kind Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListSecretForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListSecretForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listSecretForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1SecretList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listServiceAccountForAllNamespaces - - - -> V1ServiceAccountList listServiceAccountForAllNamespaces() - -list or watch objects of kind ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListServiceAccountForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListServiceAccountForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceAccountForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceAccountList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listServiceForAllNamespaces - - - -> V1ServiceList listServiceForAllNamespaces() - -list or watch objects of kind Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListServiceForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListServiceForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespace - - - -> V1Namespace patchNamespace(body) - -partially update the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespaceRequest = { - // name of the Namespace - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespaceStatus - - - -> V1Namespace patchNamespaceStatus(body) - -partially update status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespaceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedConfigMap - - - -> V1ConfigMap patchNamespacedConfigMap(body) - -partially update the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ConfigMap - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedEndpoints - - - -> V1Endpoints patchNamespacedEndpoints(body) - -partially update the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Endpoints - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedEvent - - - -> CoreV1Event patchNamespacedEvent(body) - -partially update the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -CoreV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedLimitRange - - - -> V1LimitRange patchNamespacedLimitRange(body) - -partially update the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1LimitRange - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaim(body) - -partially update the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPersistentVolumeClaimStatus - - - -> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaimStatus(body) - -partially update status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPod - - - -> V1Pod patchNamespacedPod(body) - -partially update the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodEphemeralcontainers - - - -> V1Pod patchNamespacedPodEphemeralcontainers(body) - -partially update ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodResize - - - -> V1Pod patchNamespacedPodResize(body) - -partially update resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodResizeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodStatus - - - -> V1Pod patchNamespacedPodStatus(body) - -partially update status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodTemplate - - - -> V1PodTemplate patchNamespacedPodTemplate(body) - -partially update the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicationController - - - -> V1ReplicationController patchNamespacedReplicationController(body) - -partially update the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicationControllerScale - - - -> V1Scale patchNamespacedReplicationControllerScale(body) - -partially update scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicationControllerStatus - - - -> V1ReplicationController patchNamespacedReplicationControllerStatus(body) - -partially update status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceQuota - - - -> V1ResourceQuota patchNamespacedResourceQuota(body) - -partially update the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceQuotaStatus - - - -> V1ResourceQuota patchNamespacedResourceQuotaStatus(body) - -partially update status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedSecret - - - -> V1Secret patchNamespacedSecret(body) - -partially update the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Secret - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedService - - - -> V1Service patchNamespacedService(body) - -partially update the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedServiceAccount - - - -> V1ServiceAccount patchNamespacedServiceAccount(body) - -partially update the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedServiceStatus - - - -> V1Service patchNamespacedServiceStatus(body) - -partially update status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNode - - - -> V1Node patchNode(body) - -partially update the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNodeRequest = { - // name of the Node - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNodeStatus - - - -> V1Node patchNodeStatus(body) - -partially update status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNodeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNodeStatusRequest = { - // name of the Node - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchPersistentVolume - - - -> V1PersistentVolume patchPersistentVolume(body) - -partially update the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchPersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchPersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchPersistentVolumeStatus - - - -> V1PersistentVolume patchPersistentVolumeStatus(body) - -partially update status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchPersistentVolumeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchPersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readComponentStatus - - - -> V1ComponentStatus readComponentStatus() - -read the specified ComponentStatus - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadComponentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadComponentStatusRequest = { - // name of the ComponentStatus - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readComponentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ComponentStatus | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ComponentStatus - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespace - - - -> V1Namespace readNamespace() - -read the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespaceRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespaceStatus - - - -> V1Namespace readNamespaceStatus() - -read status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespaceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedConfigMap - - - -> V1ConfigMap readNamespacedConfigMap() - -read the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ConfigMap - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedEndpoints - - - -> V1Endpoints readNamespacedEndpoints() - -read the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Endpoints - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedEvent - - - -> CoreV1Event readNamespacedEvent() - -read the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -CoreV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedLimitRange - - - -> V1LimitRange readNamespacedLimitRange() - -read the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1LimitRange - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaim() - -read the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPersistentVolumeClaimStatus - - - -> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaimStatus() - -read status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPod - - - -> V1Pod readNamespacedPod() - -read the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodEphemeralcontainers - - - -> V1Pod readNamespacedPodEphemeralcontainers() - -read ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodLog - - - -> string readNamespacedPodLog() - -read log of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodLogRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodLogRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container for which to stream logs. Defaults to only container if there is one container in the pod. (optional) - container: "container_example", - // Follow the log stream of the pod. Defaults to false. (optional) - follow: true, - // insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). (optional) - insecureSkipTLSVerifyBackend: true, - // If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. (optional) - limitBytes: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // Return previous terminated container logs. Defaults to false. (optional) - previous: true, - // A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. (optional) - sinceSeconds: 1, - // Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) - stream: "stream_example", - // If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) - tailLines: 1, - // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. (optional) - timestamps: true, -}; - -const data = await apiInstance.readNamespacedPodLog(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container for which to stream logs. Defaults to only container if there is one container in the pod. | (optional) defaults to undefined - **follow** | [**boolean**] | Follow the log stream of the pod. Defaults to false. | (optional) defaults to undefined - **insecureSkipTLSVerifyBackend** | [**boolean**] | insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). | (optional) defaults to undefined - **limitBytes** | [**number**] | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **previous** | [**boolean**] | Return previous terminated container logs. Defaults to false. | (optional) defaults to undefined - **sinceSeconds** | [**number**] | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | (optional) defaults to undefined - **stream** | [**string**] | Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined - **tailLines** | [**number**] | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined - **timestamps** | [**boolean**] | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodResize - - - -> V1Pod readNamespacedPodResize() - -read resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodResizeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodStatus - - - -> V1Pod readNamespacedPodStatus() - -read status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodTemplate - - - -> V1PodTemplate readNamespacedPodTemplate() - -read the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicationController - - - -> V1ReplicationController readNamespacedReplicationController() - -read the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicationControllerScale - - - -> V1Scale readNamespacedReplicationControllerScale() - -read scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicationControllerStatus - - - -> V1ReplicationController readNamespacedReplicationControllerStatus() - -read status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceQuota - - - -> V1ResourceQuota readNamespacedResourceQuota() - -read the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceQuotaStatus - - - -> V1ResourceQuota readNamespacedResourceQuotaStatus() - -read status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedSecret - - - -> V1Secret readNamespacedSecret() - -read the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Secret - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedService - - - -> V1Service readNamespacedService() - -read the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedServiceAccount - - - -> V1ServiceAccount readNamespacedServiceAccount() - -read the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedServiceStatus - - - -> V1Service readNamespacedServiceStatus() - -read status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNode - - - -> V1Node readNode() - -read the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNodeRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNodeStatus - - - -> V1Node readNodeStatus() - -read status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNodeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNodeStatusRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readPersistentVolume - - - -> V1PersistentVolume readPersistentVolume() - -read the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadPersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadPersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readPersistentVolumeStatus - - - -> V1PersistentVolume readPersistentVolumeStatus() - -read status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadPersistentVolumeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadPersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespace - - - -> V1Namespace replaceNamespace(body) - -replace the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespaceFinalize - - - -> V1Namespace replaceNamespaceFinalize(body) - -replace finalize of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespaceFinalizeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceFinalizeRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.replaceNamespaceFinalize(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespaceStatus - - - -> V1Namespace replaceNamespaceStatus(body) - -replace status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespaceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedConfigMap - - - -> V1ConfigMap replaceNamespacedConfigMap(body) - -replace the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - binaryData: { - "key": 'YQ==', - }, - data: { - "key": "key_example", - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ConfigMap**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ConfigMap - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedEndpoints - - - -> V1Endpoints replaceNamespacedEndpoints(body) - -replace the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - subsets: [ - { - addresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - notReadyAddresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Endpoints**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Endpoints - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedEvent - - - -> CoreV1Event replaceNamespacedEvent(body) - -replace the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - count: 1, - eventTime: "eventTime_example", - firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - involvedObject: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - kind: "kind_example", - lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - reason: "reason_example", - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingComponent: "reportingComponent_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - source: { - component: "component_example", - host: "host_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **CoreV1Event**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -CoreV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedLimitRange - - - -> V1LimitRange replaceNamespacedLimitRange(body) - -replace the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - limits: [ - { - _default: { - "key": "key_example", - }, - defaultRequest: { - "key": "key_example", - }, - max: { - "key": "key_example", - }, - maxLimitRequestRatio: { - "key": "key_example", - }, - min: { - "key": "key_example", - }, - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LimitRange**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1LimitRange - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaim(body) - -replace the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPersistentVolumeClaimStatus - - - -> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaimStatus(body) - -replace status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPod - - - -> V1Pod replaceNamespacedPod(body) - -replace the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodEphemeralcontainers - - - -> V1Pod replaceNamespacedPodEphemeralcontainers(body) - -replace ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodResize - - - -> V1Pod replaceNamespacedPodResize(body) - -replace resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodResizeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodStatus - - - -> V1Pod replaceNamespacedPodStatus(body) - -replace status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodTemplate - - - -> V1PodTemplate replaceNamespacedPodTemplate(body) - -replace the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodTemplate**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicationController - - - -> V1ReplicationController replaceNamespacedReplicationController(body) - -replace the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicationControllerScale - - - -> V1Scale replaceNamespacedReplicationControllerScale(body) - -replace scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicationControllerStatus - - - -> V1ReplicationController replaceNamespacedReplicationControllerStatus(body) - -replace status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceQuota - - - -> V1ResourceQuota replaceNamespacedResourceQuota(body) - -replace the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceQuotaStatus - - - -> V1ResourceQuota replaceNamespacedResourceQuotaStatus(body) - -replace status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedSecret - - - -> V1Secret replaceNamespacedSecret(body) - -replace the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: { - "key": 'YQ==', - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - stringData: { - "key": "key_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Secret**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Secret - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedService - - - -> V1Service replaceNamespacedService(body) - -replace the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedServiceAccount - - - -> V1ServiceAccount replaceNamespacedServiceAccount(body) - -replace the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - automountServiceAccountToken: true, - imagePullSecrets: [ - { - name: "name_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - secrets: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceAccount**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedServiceStatus - - - -> V1Service replaceNamespacedServiceStatus(body) - -replace status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNode - - - -> V1Node replaceNode(body) - -replace the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNodeRequest = { - // name of the Node - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNodeStatus - - - -> V1Node replaceNodeStatus(body) - -replace status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNodeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNodeStatusRequest = { - // name of the Node - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replacePersistentVolume - - - -> V1PersistentVolume replacePersistentVolume(body) - -replace the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplacePersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplacePersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replacePersistentVolumeStatus - - - -> V1PersistentVolume replacePersistentVolumeStatus(body) - -replace status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplacePersistentVolumeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplacePersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/core-resources/EventsApi.md b/website/docs/api-reference/core-resources/EventsApi.md deleted file mode 100644 index 891d445a1e7..00000000000 --- a/website/docs/api-reference/core-resources/EventsApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: EventsApi -title: EventsApi -sidebar_label: EventsApi -sidebar_position: 3 ---- -# EventsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/core-resources/EventsApi#getAPIGroup) | **GET** /apis/events.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, EventsApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/core-resources/EventsV1Api.md b/website/docs/api-reference/core-resources/EventsV1Api.md deleted file mode 100644 index fd13c6f99c2..00000000000 --- a/website/docs/api-reference/core-resources/EventsV1Api.md +++ /dev/null @@ -1,889 +0,0 @@ ---- -id: EventsV1Api -title: EventsV1Api -sidebar_label: EventsV1Api -sidebar_position: 4 ---- -# EventsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#createNamespacedEvent) | **POST** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**deleteCollectionNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#deleteCollectionNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**deleteNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#deleteNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**getAPIResources**](/docs/api-reference/core-resources/EventsV1Api#getAPIResources) | **GET** /apis/events.k8s.io/v1/ | -[**listEventForAllNamespaces**](/docs/api-reference/core-resources/EventsV1Api#listEventForAllNamespaces) | **GET** /apis/events.k8s.io/v1/events | -[**listNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#listNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**patchNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#patchNamespacedEvent) | **PATCH** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**readNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#readNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**replaceNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#replaceNamespacedEvent) | **PUT** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | - -### createNamespacedEvent - - - -> EventsV1Event createNamespacedEvent(body) - -create an Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiCreateNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiCreateNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - deprecatedCount: 1, - deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedSource: { - component: "component_example", - host: "host_example", - }, - eventTime: "eventTime_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - note: "note_example", - reason: "reason_example", - regarding: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingController: "reportingController_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **EventsV1Event**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -EventsV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedEvent - - - -> V1Status deleteCollectionNamespacedEvent() - -delete collection of Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiDeleteCollectionNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiDeleteCollectionNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedEvent - - - -> V1Status deleteNamespacedEvent() - -delete an Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiDeleteNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiDeleteNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listEventForAllNamespaces - - - -> EventsV1EventList listEventForAllNamespaces() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiListEventForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiListEventForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEventForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -EventsV1EventList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedEvent - - - -> EventsV1EventList listNamespacedEvent() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiListNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiListNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -EventsV1EventList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedEvent - - - -> EventsV1Event patchNamespacedEvent(body) - -partially update the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiPatchNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiPatchNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -EventsV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedEvent - - - -> EventsV1Event readNamespacedEvent() - -read the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiReadNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiReadNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -EventsV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedEvent - - - -> EventsV1Event replaceNamespacedEvent(body) - -replace the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiReplaceNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiReplaceNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - deprecatedCount: 1, - deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedSource: { - component: "component_example", - host: "host_example", - }, - eventTime: "eventTime_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - note: "note_example", - reason: "reason_example", - regarding: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingController: "reportingController_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **EventsV1Event**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -EventsV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/core-resources/NodeApi.md b/website/docs/api-reference/core-resources/NodeApi.md deleted file mode 100644 index 975a97e8ac4..00000000000 --- a/website/docs/api-reference/core-resources/NodeApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: NodeApi -title: NodeApi -sidebar_label: NodeApi -sidebar_position: 5 ---- -# NodeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/core-resources/NodeApi#getAPIGroup) | **GET** /apis/node.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, NodeApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/core-resources/NodeV1Api.md b/website/docs/api-reference/core-resources/NodeV1Api.md deleted file mode 100644 index 95f49bda4a8..00000000000 --- a/website/docs/api-reference/core-resources/NodeV1Api.md +++ /dev/null @@ -1,751 +0,0 @@ ---- -id: NodeV1Api -title: NodeV1Api -sidebar_label: NodeV1Api -sidebar_position: 6 ---- -# NodeV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#createRuntimeClass) | **POST** /apis/node.k8s.io/v1/runtimeclasses | -[**deleteCollectionRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#deleteCollectionRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses | -[**deleteRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#deleteRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**getAPIResources**](/docs/api-reference/core-resources/NodeV1Api#getAPIResources) | **GET** /apis/node.k8s.io/v1/ | -[**listRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#listRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses | -[**patchRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#patchRuntimeClass) | **PATCH** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**readRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#readRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**replaceRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#replaceRuntimeClass) | **PUT** /apis/node.k8s.io/v1/runtimeclasses/{name} | - -### createRuntimeClass - - - -> V1RuntimeClass createRuntimeClass(body) - -create a RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiCreateRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiCreateRuntimeClassRequest = { - - body: { - apiVersion: "apiVersion_example", - handler: "handler_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - overhead: { - podFixed: { - "key": "key_example", - }, - }, - scheduling: { - nodeSelector: { - "key": "key_example", - }, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RuntimeClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1RuntimeClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionRuntimeClass - - - -> V1Status deleteCollectionRuntimeClass() - -delete collection of RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiDeleteCollectionRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiDeleteCollectionRuntimeClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteRuntimeClass - - - -> V1Status deleteRuntimeClass() - -delete a RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiDeleteRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiDeleteRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listRuntimeClass - - - -> V1RuntimeClassList listRuntimeClass() - -list or watch objects of kind RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiListRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiListRuntimeClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RuntimeClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchRuntimeClass - - - -> V1RuntimeClass patchRuntimeClass(body) - -partially update the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiPatchRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiPatchRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1RuntimeClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readRuntimeClass - - - -> V1RuntimeClass readRuntimeClass() - -read the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiReadRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiReadRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1RuntimeClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceRuntimeClass - - - -> V1RuntimeClass replaceRuntimeClass(body) - -replace the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiReplaceRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiReplaceRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - handler: "handler_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - overhead: { - podFixed: { - "key": "key_example", - }, - }, - scheduling: { - nodeSelector: { - "key": "key_example", - }, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RuntimeClass**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1RuntimeClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/core-resources/_category_.json b/website/docs/api-reference/core-resources/_category_.json deleted file mode 100644 index b8f850a4d43..00000000000 --- a/website/docs/api-reference/core-resources/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Core Resources", - "position": 1 -} diff --git a/website/docs/api-reference/networking/DiscoveryApi.md b/website/docs/api-reference/networking/DiscoveryApi.md deleted file mode 100644 index ba4ca020e47..00000000000 --- a/website/docs/api-reference/networking/DiscoveryApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: DiscoveryApi -title: DiscoveryApi -sidebar_label: DiscoveryApi -sidebar_position: 1 ---- -# DiscoveryApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/networking/DiscoveryApi#getAPIGroup) | **GET** /apis/discovery.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, DiscoveryApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/networking/DiscoveryV1Api.md b/website/docs/api-reference/networking/DiscoveryV1Api.md deleted file mode 100644 index d9fcde9ab2f..00000000000 --- a/website/docs/api-reference/networking/DiscoveryV1Api.md +++ /dev/null @@ -1,913 +0,0 @@ ---- -id: DiscoveryV1Api -title: DiscoveryV1Api -sidebar_label: DiscoveryV1Api -sidebar_position: 2 ---- -# DiscoveryV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#createNamespacedEndpointSlice) | **POST** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**deleteCollectionNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#deleteCollectionNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**deleteNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#deleteNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**getAPIResources**](/docs/api-reference/networking/DiscoveryV1Api#getAPIResources) | **GET** /apis/discovery.k8s.io/v1/ | -[**listEndpointSliceForAllNamespaces**](/docs/api-reference/networking/DiscoveryV1Api#listEndpointSliceForAllNamespaces) | **GET** /apis/discovery.k8s.io/v1/endpointslices | -[**listNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#listNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**patchNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#patchNamespacedEndpointSlice) | **PATCH** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**readNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#readNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**replaceNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#replaceNamespacedEndpointSlice) | **PUT** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | - -### createNamespacedEndpointSlice - - - -> V1EndpointSlice createNamespacedEndpointSlice(body) - -create an EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiCreateNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiCreateNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - addressType: "addressType_example", - apiVersion: "apiVersion_example", - endpoints: [ - { - addresses: [ - "addresses_example", - ], - conditions: { - ready: true, - serving: true, - terminating: true, - }, - deprecatedTopology: { - "key": "key_example", - }, - hints: { - forNodes: [ - { - name: "name_example", - }, - ], - forZones: [ - { - name: "name_example", - }, - ], - }, - hostname: "hostname_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - zone: "zone_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1EndpointSlice**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1EndpointSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedEndpointSlice - - - -> V1Status deleteCollectionNamespacedEndpointSlice() - -delete collection of EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedEndpointSlice - - - -> V1Status deleteNamespacedEndpointSlice() - -delete an EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listEndpointSliceForAllNamespaces - - - -> V1EndpointSliceList listEndpointSliceForAllNamespaces() - -list or watch objects of kind EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEndpointSliceForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1EndpointSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedEndpointSlice - - - -> V1EndpointSliceList listNamespacedEndpointSlice() - -list or watch objects of kind EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiListNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiListNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1EndpointSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedEndpointSlice - - - -> V1EndpointSlice patchNamespacedEndpointSlice(body) - -partially update the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiPatchNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiPatchNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1EndpointSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedEndpointSlice - - - -> V1EndpointSlice readNamespacedEndpointSlice() - -read the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiReadNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiReadNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1EndpointSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedEndpointSlice - - - -> V1EndpointSlice replaceNamespacedEndpointSlice(body) - -replace the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - addressType: "addressType_example", - apiVersion: "apiVersion_example", - endpoints: [ - { - addresses: [ - "addresses_example", - ], - conditions: { - ready: true, - serving: true, - terminating: true, - }, - deprecatedTopology: { - "key": "key_example", - }, - hints: { - forNodes: [ - { - name: "name_example", - }, - ], - forZones: [ - { - name: "name_example", - }, - ], - }, - hostname: "hostname_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - zone: "zone_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1EndpointSlice**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1EndpointSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/networking/NetworkingApi.md b/website/docs/api-reference/networking/NetworkingApi.md deleted file mode 100644 index 47fb65146fa..00000000000 --- a/website/docs/api-reference/networking/NetworkingApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: NetworkingApi -title: NetworkingApi -sidebar_label: NetworkingApi -sidebar_position: 3 ---- -# NetworkingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/networking/NetworkingApi#getAPIGroup) | **GET** /apis/networking.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, NetworkingApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/networking/NetworkingV1Api.md b/website/docs/api-reference/networking/NetworkingV1Api.md deleted file mode 100644 index b49013d79f0..00000000000 --- a/website/docs/api-reference/networking/NetworkingV1Api.md +++ /dev/null @@ -1,4552 +0,0 @@ ---- -id: NetworkingV1Api -title: NetworkingV1Api -sidebar_label: NetworkingV1Api -sidebar_position: 4 ---- -# NetworkingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createIPAddress**](/docs/api-reference/networking/NetworkingV1Api#createIPAddress) | **POST** /apis/networking.k8s.io/v1/ipaddresses | -[**createIngressClass**](/docs/api-reference/networking/NetworkingV1Api#createIngressClass) | **POST** /apis/networking.k8s.io/v1/ingressclasses | -[**createNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#createNamespacedIngress) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**createNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#createNamespacedNetworkPolicy) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**createServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1/servicecidrs | -[**deleteCollectionIPAddress**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses | -[**deleteCollectionIngressClass**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses | -[**deleteCollectionNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**deleteCollectionNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**deleteCollectionServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs | -[**deleteIPAddress**](/docs/api-reference/networking/NetworkingV1Api#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**deleteIngressClass**](/docs/api-reference/networking/NetworkingV1Api#deleteIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**deleteNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#deleteNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**deleteNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#deleteNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**deleteServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**getAPIResources**](/docs/api-reference/networking/NetworkingV1Api#getAPIResources) | **GET** /apis/networking.k8s.io/v1/ | -[**listIPAddress**](/docs/api-reference/networking/NetworkingV1Api#listIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses | -[**listIngressClass**](/docs/api-reference/networking/NetworkingV1Api#listIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses | -[**listIngressForAllNamespaces**](/docs/api-reference/networking/NetworkingV1Api#listIngressForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/ingresses | -[**listNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#listNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**listNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#listNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**listNetworkPolicyForAllNamespaces**](/docs/api-reference/networking/NetworkingV1Api#listNetworkPolicyForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/networkpolicies | -[**listServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs | -[**patchIPAddress**](/docs/api-reference/networking/NetworkingV1Api#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**patchIngressClass**](/docs/api-reference/networking/NetworkingV1Api#patchIngressClass) | **PATCH** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**patchNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedIngress) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**patchNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedIngressStatus) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**patchNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedNetworkPolicy) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**patchServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**patchServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | -[**readIPAddress**](/docs/api-reference/networking/NetworkingV1Api#readIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**readIngressClass**](/docs/api-reference/networking/NetworkingV1Api#readIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**readNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**readNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedIngressStatus) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**readNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**readServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**readServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | -[**replaceIPAddress**](/docs/api-reference/networking/NetworkingV1Api#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**replaceIngressClass**](/docs/api-reference/networking/NetworkingV1Api#replaceIngressClass) | **PUT** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**replaceNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedIngress) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**replaceNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedIngressStatus) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**replaceNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedNetworkPolicy) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**replaceServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**replaceServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | - -### createIPAddress - - - -> V1IPAddress createIPAddress(body) - -create an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateIPAddressRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IPAddress**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createIngressClass - - - -> V1IngressClass createIngressClass(body) - -create an IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateIngressClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controller: "controller_example", - parameters: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - scope: "scope_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IngressClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1IngressClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedIngress - - - -> V1Ingress createNamespacedIngress(body) - -create an Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedNetworkPolicy - - - -> V1NetworkPolicy createNamespacedNetworkPolicy(body) - -create a NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - egress: [ - { - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - to: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - }, - ], - ingress: [ - { - _from: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - }, - ], - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - policyTypes: [ - "policyTypes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1NetworkPolicy**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createServiceCIDR - - - -> V1ServiceCIDR createServiceCIDR(body) - -create a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateServiceCIDRRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionIPAddress - - - -> V1Status deleteCollectionIPAddress() - -delete collection of IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionIngressClass - - - -> V1Status deleteCollectionIngressClass() - -delete collection of IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionIngressClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedIngress - - - -> V1Status deleteCollectionNamespacedIngress() - -delete collection of Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedNetworkPolicy - - - -> V1Status deleteCollectionNamespacedNetworkPolicy() - -delete collection of NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionServiceCIDR - - - -> V1Status deleteCollectionServiceCIDR() - -delete collection of ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteIPAddress - - - -> V1Status deleteIPAddress() - -delete an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteIngressClass - - - -> V1Status deleteIngressClass() - -delete an IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteIngressClassRequest = { - // name of the IngressClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedIngress - - - -> V1Status deleteNamespacedIngress() - -delete an Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedNetworkPolicy - - - -> V1Status deleteNamespacedNetworkPolicy() - -delete a NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteServiceCIDR - - - -> V1Status deleteServiceCIDR() - -delete a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listIPAddress - - - -> V1IPAddressList listIPAddress() - -list or watch objects of kind IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1IPAddressList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listIngressClass - - - -> V1IngressClassList listIngressClass() - -list or watch objects of kind IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIngressClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1IngressClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listIngressForAllNamespaces - - - -> V1IngressList listIngressForAllNamespaces() - -list or watch objects of kind Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListIngressForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIngressForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIngressForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1IngressList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedIngress - - - -> V1IngressList listNamespacedIngress() - -list or watch objects of kind Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1IngressList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedNetworkPolicy - - - -> V1NetworkPolicyList listNamespacedNetworkPolicy() - -list or watch objects of kind NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNetworkPolicyForAllNamespaces - - - -> V1NetworkPolicyList listNetworkPolicyForAllNamespaces() - -list or watch objects of kind NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNetworkPolicyForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listServiceCIDR - - - -> V1ServiceCIDRList listServiceCIDR() - -list or watch objects of kind ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDRList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchIPAddress - - - -> V1IPAddress patchIPAddress(body) - -partially update the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchIngressClass - - - -> V1IngressClass patchIngressClass(body) - -partially update the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchIngressClassRequest = { - // name of the IngressClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1IngressClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedIngress - - - -> V1Ingress patchNamespacedIngress(body) - -partially update the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedIngressStatus - - - -> V1Ingress patchNamespacedIngressStatus(body) - -partially update status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchNamespacedIngressStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedNetworkPolicy - - - -> V1NetworkPolicy patchNamespacedNetworkPolicy(body) - -partially update the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchServiceCIDR - - - -> V1ServiceCIDR patchServiceCIDR(body) - -partially update the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchServiceCIDRStatus - - - -> V1ServiceCIDR patchServiceCIDRStatus(body) - -partially update status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readIPAddress - - - -> V1IPAddress readIPAddress() - -read the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readIngressClass - - - -> V1IngressClass readIngressClass() - -read the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadIngressClassRequest = { - // name of the IngressClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1IngressClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedIngress - - - -> V1Ingress readNamespacedIngress() - -read the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedIngressStatus - - - -> V1Ingress readNamespacedIngressStatus() - -read status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadNamespacedIngressStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedNetworkPolicy - - - -> V1NetworkPolicy readNamespacedNetworkPolicy() - -read the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1NetworkPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readServiceCIDR - - - -> V1ServiceCIDR readServiceCIDR() - -read the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readServiceCIDRStatus - - - -> V1ServiceCIDR readServiceCIDRStatus() - -read status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceIPAddress - - - -> V1IPAddress replaceIPAddress(body) - -replace the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IPAddress**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceIngressClass - - - -> V1IngressClass replaceIngressClass(body) - -replace the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceIngressClassRequest = { - // name of the IngressClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controller: "controller_example", - parameters: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - scope: "scope_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IngressClass**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1IngressClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedIngress - - - -> V1Ingress replaceNamespacedIngress(body) - -replace the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedIngressStatus - - - -> V1Ingress replaceNamespacedIngressStatus(body) - -replace status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceNamespacedIngressStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedNetworkPolicy - - - -> V1NetworkPolicy replaceNamespacedNetworkPolicy(body) - -replace the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - egress: [ - { - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - to: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - }, - ], - ingress: [ - { - _from: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - }, - ], - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - policyTypes: [ - "policyTypes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1NetworkPolicy**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceServiceCIDR - - - -> V1ServiceCIDR replaceServiceCIDR(body) - -replace the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceServiceCIDRStatus - - - -> V1ServiceCIDR replaceServiceCIDRStatus(body) - -replace status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/networking/NetworkingV1beta1Api.md b/website/docs/api-reference/networking/NetworkingV1beta1Api.md deleted file mode 100644 index f14ea0a610c..00000000000 --- a/website/docs/api-reference/networking/NetworkingV1beta1Api.md +++ /dev/null @@ -1,1675 +0,0 @@ ---- -id: NetworkingV1beta1Api -title: NetworkingV1beta1Api -sidebar_label: NetworkingV1beta1Api -sidebar_position: 5 ---- -# NetworkingV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#createIPAddress) | **POST** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**createServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**deleteCollectionIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**deleteCollectionServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**deleteIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**deleteServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**getAPIResources**](/docs/api-reference/networking/NetworkingV1beta1Api#getAPIResources) | **GET** /apis/networking.k8s.io/v1beta1/ | -[**listIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#listIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**listServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**patchIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**patchServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**patchServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | -[**readIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#readIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**readServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**readServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | -[**replaceIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**replaceServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**replaceServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | - -### createIPAddress - - - -> V1beta1IPAddress createIPAddress(body) - -create an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiCreateIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiCreateIPAddressRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1IPAddress**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createServiceCIDR - - - -> V1beta1ServiceCIDR createServiceCIDR(body) - -create a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiCreateServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiCreateServiceCIDRRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionIPAddress - - - -> V1Status deleteCollectionIPAddress() - -delete collection of IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiDeleteCollectionIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteCollectionIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionServiceCIDR - - - -> V1Status deleteCollectionServiceCIDR() - -delete collection of ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteIPAddress - - - -> V1Status deleteIPAddress() - -delete an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiDeleteIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteServiceCIDR - - - -> V1Status deleteServiceCIDR() - -delete a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiDeleteServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listIPAddress - - - -> V1beta1IPAddressList listIPAddress() - -list or watch objects of kind IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiListIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiListIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1IPAddressList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listServiceCIDR - - - -> V1beta1ServiceCIDRList listServiceCIDR() - -list or watch objects of kind ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiListServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiListServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDRList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchIPAddress - - - -> V1beta1IPAddress patchIPAddress(body) - -partially update the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiPatchIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchServiceCIDR - - - -> V1beta1ServiceCIDR patchServiceCIDR(body) - -partially update the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiPatchServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchServiceCIDRStatus - - - -> V1beta1ServiceCIDR patchServiceCIDRStatus(body) - -partially update status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiPatchServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readIPAddress - - - -> V1beta1IPAddress readIPAddress() - -read the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReadIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readServiceCIDR - - - -> V1beta1ServiceCIDR readServiceCIDR() - -read the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReadServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readServiceCIDRStatus - - - -> V1beta1ServiceCIDR readServiceCIDRStatus() - -read status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReadServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceIPAddress - - - -> V1beta1IPAddress replaceIPAddress(body) - -replace the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReplaceIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1IPAddress**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceServiceCIDR - - - -> V1beta1ServiceCIDR replaceServiceCIDR(body) - -replace the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReplaceServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceServiceCIDRStatus - - - -> V1beta1ServiceCIDR replaceServiceCIDRStatus(body) - -replace status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/networking/_category_.json b/website/docs/api-reference/networking/_category_.json deleted file mode 100644 index c1c4f2787e3..00000000000 --- a/website/docs/api-reference/networking/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Networking", - "position": 3 -} diff --git a/website/docs/api-reference/other/ApisApi.md b/website/docs/api-reference/other/ApisApi.md deleted file mode 100644 index 966043d77e2..00000000000 --- a/website/docs/api-reference/other/ApisApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: ApisApi -title: ApisApi -sidebar_label: ApisApi -sidebar_position: 1 ---- -# ApisApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIVersions**](/docs/api-reference/other/ApisApi#getAPIVersions) | **GET** /apis/ | - -### getAPIVersions - - - -> V1APIGroupList getAPIVersions() - -get available API versions - -### Example - - -```typescript -import { createConfiguration, ApisApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApisApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIVersions(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroupList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/AutoscalingApi.md b/website/docs/api-reference/other/AutoscalingApi.md deleted file mode 100644 index 55b0e1d62ba..00000000000 --- a/website/docs/api-reference/other/AutoscalingApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AutoscalingApi -title: AutoscalingApi -sidebar_label: AutoscalingApi -sidebar_position: 2 ---- -# AutoscalingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/other/AutoscalingApi#getAPIGroup) | **GET** /apis/autoscaling/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AutoscalingApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/AutoscalingV1Api.md b/website/docs/api-reference/other/AutoscalingV1Api.md deleted file mode 100644 index 0b0e3e3b682..00000000000 --- a/website/docs/api-reference/other/AutoscalingV1Api.md +++ /dev/null @@ -1,1125 +0,0 @@ ---- -id: AutoscalingV1Api -title: AutoscalingV1Api -sidebar_label: AutoscalingV1Api -sidebar_position: 3 ---- -# AutoscalingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteCollectionNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**getAPIResources**](/docs/api-reference/other/AutoscalingV1Api#getAPIResources) | **GET** /apis/autoscaling/v1/ | -[**listHorizontalPodAutoscalerForAllNamespaces**](/docs/api-reference/other/AutoscalingV1Api#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v1/horizontalpodautoscalers | -[**listNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**patchNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**patchNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**readNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**readNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**replaceNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**replaceNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | - -### createNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) - -create a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedHorizontalPodAutoscaler - - - -> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() - -delete collection of HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedHorizontalPodAutoscaler - - - -> V1Status deleteNamespacedHorizontalPodAutoscaler() - -delete a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listHorizontalPodAutoscalerForAllNamespaces - - - -> V1HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscalerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscalerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) - -partially update the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedHorizontalPodAutoscalerStatus - - - -> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) - -partially update status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() - -read the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedHorizontalPodAutoscalerStatus - - - -> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() - -read status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) - -replace the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedHorizontalPodAutoscalerStatus - - - -> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) - -replace status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/AutoscalingV2Api.md b/website/docs/api-reference/other/AutoscalingV2Api.md deleted file mode 100644 index 95197559ac4..00000000000 --- a/website/docs/api-reference/other/AutoscalingV2Api.md +++ /dev/null @@ -1,1833 +0,0 @@ ---- -id: AutoscalingV2Api -title: AutoscalingV2Api -sidebar_label: AutoscalingV2Api -sidebar_position: 4 ---- -# AutoscalingV2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteCollectionNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**getAPIResources**](/docs/api-reference/other/AutoscalingV2Api#getAPIResources) | **GET** /apis/autoscaling/v2/ | -[**listHorizontalPodAutoscalerForAllNamespaces**](/docs/api-reference/other/AutoscalingV2Api#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v2/horizontalpodautoscalers | -[**listNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**patchNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**patchNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**readNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**readNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**replaceNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**replaceNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | - -### createNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) - -create a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedHorizontalPodAutoscaler - - - -> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() - -delete collection of HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedHorizontalPodAutoscaler - - - -> V1Status deleteNamespacedHorizontalPodAutoscaler() - -delete a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listHorizontalPodAutoscalerForAllNamespaces - - - -> V2HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscalerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscalerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) - -partially update the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedHorizontalPodAutoscalerStatus - - - -> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) - -partially update status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() - -read the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedHorizontalPodAutoscalerStatus - - - -> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() - -read status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) - -replace the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedHorizontalPodAutoscalerStatus - - - -> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) - -replace status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/CustomObjectsApi.md b/website/docs/api-reference/other/CustomObjectsApi.md deleted file mode 100644 index 7b1af985aa2..00000000000 --- a/website/docs/api-reference/other/CustomObjectsApi.md +++ /dev/null @@ -1,2234 +0,0 @@ ---- -id: CustomObjectsApi -title: CustomObjectsApi -sidebar_label: CustomObjectsApi -sidebar_position: 5 ---- -# CustomObjectsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#createClusterCustomObject) | **POST** /apis/{group}/{version}/{plural} | -[**createNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#createNamespacedCustomObject) | **POST** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**deleteClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural}/{name} | -[**deleteCollectionClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteCollectionClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural} | -[**deleteCollectionNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteCollectionNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**deleteNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**getAPIResources**](/docs/api-reference/other/CustomObjectsApi#getAPIResources) | **GET** /apis/{group}/{version} | -[**getClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObject) | **GET** /apis/{group}/{version}/{plural}/{name} | -[**getClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObjectScale) | **GET** /apis/{group}/{version}/{plural}/{name}/scale | -[**getClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObjectStatus) | **GET** /apis/{group}/{version}/{plural}/{name}/status | -[**getNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**getNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObjectScale) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**getNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObjectStatus) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | -[**listClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#listClusterCustomObject) | **GET** /apis/{group}/{version}/{plural} | -[**listCustomObjectForAllNamespaces**](/docs/api-reference/other/CustomObjectsApi#listCustomObjectForAllNamespaces) | **GET** /apis/{group}/{version}/{resource_plural} | -[**listNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#listNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**patchClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObject) | **PATCH** /apis/{group}/{version}/{plural}/{name} | -[**patchClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObjectScale) | **PATCH** /apis/{group}/{version}/{plural}/{name}/scale | -[**patchClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObjectStatus) | **PATCH** /apis/{group}/{version}/{plural}/{name}/status | -[**patchNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObject) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**patchNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObjectScale) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**patchNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObjectStatus) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | -[**replaceClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObject) | **PUT** /apis/{group}/{version}/{plural}/{name} | -[**replaceClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObjectScale) | **PUT** /apis/{group}/{version}/{plural}/{name}/scale | -[**replaceClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObjectStatus) | **PUT** /apis/{group}/{version}/{plural}/{name}/status | -[**replaceNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObject) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**replaceNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObjectScale) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**replaceNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObjectStatus) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | - -### createClusterCustomObject - - - -> any createClusterCustomObject(body) - -Creates a cluster scoped Custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiCreateClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiCreateClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // The JSON schema of the Resource to create. - body: {}, - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to create. | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Created | - | -**401** | Unauthorized | - | - -### createNamespacedCustomObject - - - -> any createNamespacedCustomObject(body) - -Creates a namespace scoped Custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiCreateNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiCreateNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // The JSON schema of the Resource to create. - body: {}, - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to create. | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Created | - | -**401** | Unauthorized | - | - -### deleteClusterCustomObject - - - -> any deleteClusterCustomObject() - -Deletes the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiDeleteClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterCustomObject - - - -> any deleteCollectionClusterCustomObject() - -Delete collection of cluster scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiDeleteCollectionClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteCollectionClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedCustomObject - - - -> any deleteCollectionNamespacedCustomObject() - -Delete collection of namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedCustomObject - - - -> any deleteNamespacedCustomObject() - -Deletes the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiDeleteNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetAPIResourcesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetAPIResourcesRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", -}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getClusterCustomObject - - - -> any getClusterCustomObject() - -Returns a cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A single Resource | - | -**401** | Unauthorized | - | - -### getClusterCustomObjectScale - - - -> any getClusterCustomObjectScale() - -read scale of the specified custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getClusterCustomObjectStatus - - - -> any getClusterCustomObjectStatus() - -read status of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getNamespacedCustomObject - - - -> any getNamespacedCustomObject() - -Returns a namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A single Resource | - | -**401** | Unauthorized | - | - -### getNamespacedCustomObjectScale - - - -> any getNamespacedCustomObjectScale() - -read scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getNamespacedCustomObjectStatus - - - -> any getNamespacedCustomObjectStatus() - -read status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterCustomObject - - - -> any listClusterCustomObject() - -list or watch cluster scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiListClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCustomObjectForAllNamespaces - - - -> any listCustomObjectForAllNamespaces() - -list or watch namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiListCustomObjectForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListCustomObjectForAllNamespacesRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - resourcePlural: "resource_plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listCustomObjectForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **resourcePlural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedCustomObject - - - -> any listNamespacedCustomObject() - -list or watch namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiListNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterCustomObject - - - -> any patchClusterCustomObject(body) - -patch the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to patch. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to patch. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterCustomObjectScale - - - -> any patchClusterCustomObjectScale(body) - -partially update scale of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterCustomObjectStatus - - - -> any patchClusterCustomObjectStatus(body) - -partially update status of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedCustomObject - - - -> any patchNamespacedCustomObject(body) - -patch the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to patch. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to patch. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedCustomObjectScale - - - -> any patchNamespacedCustomObjectScale(body) - -partially update scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedCustomObjectStatus - - - -> any patchNamespacedCustomObjectStatus(body) - -partially update status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterCustomObject - - - -> any replaceClusterCustomObject(body) - -replace the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to replace. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to replace. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterCustomObjectScale - - - -> any replaceClusterCustomObjectScale(body) - -replace scale of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceClusterCustomObjectStatus - - - -> any replaceClusterCustomObjectStatus(body) - -replace status of the cluster scoped specified custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedCustomObject - - - -> any replaceNamespacedCustomObject(body) - -replace the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to replace. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to replace. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedCustomObjectScale - - - -> any replaceNamespacedCustomObjectScale(body) - -replace scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedCustomObjectStatus - - - -> any replaceNamespacedCustomObjectStatus(body) - -replace status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/FlowcontrolApiserverApi.md b/website/docs/api-reference/other/FlowcontrolApiserverApi.md deleted file mode 100644 index 41a4b06ea22..00000000000 --- a/website/docs/api-reference/other/FlowcontrolApiserverApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: FlowcontrolApiserverApi -title: FlowcontrolApiserverApi -sidebar_label: FlowcontrolApiserverApi -sidebar_position: 6 ---- -# FlowcontrolApiserverApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/other/FlowcontrolApiserverApi#getAPIGroup) | **GET** /apis/flowcontrol.apiserver.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/FlowcontrolApiserverV1Api.md b/website/docs/api-reference/other/FlowcontrolApiserverV1Api.md deleted file mode 100644 index e4a02865c2d..00000000000 --- a/website/docs/api-reference/other/FlowcontrolApiserverV1Api.md +++ /dev/null @@ -1,2147 +0,0 @@ ---- -id: FlowcontrolApiserverV1Api -title: FlowcontrolApiserverV1Api -sidebar_label: FlowcontrolApiserverV1Api -sidebar_position: 7 ---- -# FlowcontrolApiserverV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#createFlowSchema) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**createPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#createPriorityLevelConfiguration) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**deleteCollectionFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteCollectionFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**deleteCollectionPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteCollectionPriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**deleteFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**deletePriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deletePriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**getAPIResources**](/docs/api-reference/other/FlowcontrolApiserverV1Api#getAPIResources) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/ | -[**listFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#listFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**listPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#listPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**patchFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchFlowSchema) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**patchFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchFlowSchemaStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**patchPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchPriorityLevelConfiguration) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**patchPriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchPriorityLevelConfigurationStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | -[**readFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**readFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readFlowSchemaStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**readPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**readPriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readPriorityLevelConfigurationStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | -[**replaceFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replaceFlowSchema) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**replaceFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replaceFlowSchemaStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**replacePriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replacePriorityLevelConfiguration) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**replacePriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replacePriorityLevelConfigurationStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | - -### createFlowSchema - - - -> V1FlowSchema createFlowSchema(body) - -create a FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiCreateFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiCreateFlowSchemaRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createPriorityLevelConfiguration - - - -> V1PriorityLevelConfiguration createPriorityLevelConfiguration(body) - -create a PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionFlowSchema - - - -> V1Status deleteCollectionFlowSchema() - -delete collection of FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionPriorityLevelConfiguration - - - -> V1Status deleteCollectionPriorityLevelConfiguration() - -delete collection of PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteFlowSchema - - - -> V1Status deleteFlowSchema() - -delete a FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deletePriorityLevelConfiguration - - - -> V1Status deletePriorityLevelConfiguration() - -delete a PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listFlowSchema - - - -> V1FlowSchemaList listFlowSchema() - -list or watch objects of kind FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiListFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiListFlowSchemaRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1FlowSchemaList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPriorityLevelConfiguration - - - -> V1PriorityLevelConfigurationList listPriorityLevelConfiguration() - -list or watch objects of kind PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfigurationList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchFlowSchema - - - -> V1FlowSchema patchFlowSchema(body) - -partially update the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiPatchFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchFlowSchemaStatus - - - -> V1FlowSchema patchFlowSchemaStatus(body) - -partially update status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchPriorityLevelConfiguration - - - -> V1PriorityLevelConfiguration patchPriorityLevelConfiguration(body) - -partially update the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchPriorityLevelConfigurationStatus - - - -> V1PriorityLevelConfiguration patchPriorityLevelConfigurationStatus(body) - -partially update status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readFlowSchema - - - -> V1FlowSchema readFlowSchema() - -read the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReadFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readFlowSchemaStatus - - - -> V1FlowSchema readFlowSchemaStatus() - -read status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readPriorityLevelConfiguration - - - -> V1PriorityLevelConfiguration readPriorityLevelConfiguration() - -read the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readPriorityLevelConfigurationStatus - - - -> V1PriorityLevelConfiguration readPriorityLevelConfigurationStatus() - -read status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceFlowSchema - - - -> V1FlowSchema replaceFlowSchema(body) - -replace the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceFlowSchemaStatus - - - -> V1FlowSchema replaceFlowSchemaStatus(body) - -replace status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replacePriorityLevelConfiguration - - - -> V1PriorityLevelConfiguration replacePriorityLevelConfiguration(body) - -replace the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replacePriorityLevelConfigurationStatus - - - -> V1PriorityLevelConfiguration replacePriorityLevelConfigurationStatus(body) - -replace status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/InternalApiserverApi.md b/website/docs/api-reference/other/InternalApiserverApi.md deleted file mode 100644 index 004c2a11502..00000000000 --- a/website/docs/api-reference/other/InternalApiserverApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: InternalApiserverApi -title: InternalApiserverApi -sidebar_label: InternalApiserverApi -sidebar_position: 8 ---- -# InternalApiserverApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/other/InternalApiserverApi#getAPIGroup) | **GET** /apis/internal.apiserver.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, InternalApiserverApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/InternalApiserverV1alpha1Api.md b/website/docs/api-reference/other/InternalApiserverV1alpha1Api.md deleted file mode 100644 index dad0d5fc68c..00000000000 --- a/website/docs/api-reference/other/InternalApiserverV1alpha1Api.md +++ /dev/null @@ -1,1037 +0,0 @@ ---- -id: InternalApiserverV1alpha1Api -title: InternalApiserverV1alpha1Api -sidebar_label: InternalApiserverV1alpha1Api -sidebar_position: 9 ---- -# InternalApiserverV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#createStorageVersion) | **POST** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**deleteCollectionStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#deleteCollectionStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**deleteStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#deleteStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**getAPIResources**](/docs/api-reference/other/InternalApiserverV1alpha1Api#getAPIResources) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/ | -[**listStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#listStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**patchStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#patchStorageVersion) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**patchStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#patchStorageVersionStatus) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | -[**readStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#readStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**readStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#readStorageVersionStatus) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | -[**replaceStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#replaceStorageVersion) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**replaceStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#replaceStorageVersionStatus) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | - -### createStorageVersion - - - -> V1alpha1StorageVersion createStorageVersion(body) - -create a StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiCreateStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiCreateStorageVersionRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionStorageVersion - - - -> V1Status deleteCollectionStorageVersion() - -delete collection of StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteStorageVersion - - - -> V1Status deleteStorageVersion() - -delete a StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiDeleteStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiDeleteStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listStorageVersion - - - -> V1alpha1StorageVersionList listStorageVersion() - -list or watch objects of kind StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiListStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiListStorageVersionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersionList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchStorageVersion - - - -> V1alpha1StorageVersion patchStorageVersion(body) - -partially update the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiPatchStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiPatchStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchStorageVersionStatus - - - -> V1alpha1StorageVersion patchStorageVersionStatus(body) - -partially update status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readStorageVersion - - - -> V1alpha1StorageVersion readStorageVersion() - -read the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiReadStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReadStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readStorageVersionStatus - - - -> V1alpha1StorageVersion readStorageVersionStatus() - -read status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceStorageVersion - - - -> V1alpha1StorageVersion replaceStorageVersion(body) - -replace the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiReplaceStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReplaceStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceStorageVersionStatus - - - -> V1alpha1StorageVersion replaceStorageVersionStatus(body) - -replace status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/LogsApi.md b/website/docs/api-reference/other/LogsApi.md deleted file mode 100644 index 6b4953a3eea..00000000000 --- a/website/docs/api-reference/other/LogsApi.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: LogsApi -title: LogsApi -sidebar_label: LogsApi -sidebar_position: 10 ---- -# LogsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**logFileHandler**](/docs/api-reference/other/LogsApi#logFileHandler) | **GET** /logs/{logpath} | -[**logFileListHandler**](/docs/api-reference/other/LogsApi#logFileListHandler) | **GET** /logs/ | - -### logFileHandler - - - -> logFileHandler() - -### Example - - -```typescript -import { createConfiguration, LogsApi } from '@kubernetes/client-node'; -import type { LogsApiLogFileHandlerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new LogsApi(configuration); - -const request: LogsApiLogFileHandlerRequest = { - // path to the log - logpath: "logpath_example", -}; - -const data = await apiInstance.logFileHandler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **logpath** | [**string**] | path to the log | defaults to undefined - -### Return type - -void (empty response body) - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**401** | Unauthorized | - | - -### logFileListHandler - - - -> logFileListHandler() - -### Example - - -```typescript -import { createConfiguration, LogsApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new LogsApi(configuration); - -const request = {}; - -const data = await apiInstance.logFileListHandler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/OpenidApi.md b/website/docs/api-reference/other/OpenidApi.md deleted file mode 100644 index 7c54bab7421..00000000000 --- a/website/docs/api-reference/other/OpenidApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: OpenidApi -title: OpenidApi -sidebar_label: OpenidApi -sidebar_position: 11 ---- -# OpenidApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getServiceAccountIssuerOpenIDKeyset**](/docs/api-reference/other/OpenidApi#getServiceAccountIssuerOpenIDKeyset) | **GET** /openid/v1/jwks | - -### getServiceAccountIssuerOpenIDKeyset - - - -> string getServiceAccountIssuerOpenIDKeyset() - -get service account issuer OpenID JSON Web Key Set (contains public token verification keys) - -### Example - - -```typescript -import { createConfiguration, OpenidApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new OpenidApi(configuration); - -const request = {}; - -const data = await apiInstance.getServiceAccountIssuerOpenIDKeyset(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/jwk-set+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/ResourceApi.md b/website/docs/api-reference/other/ResourceApi.md deleted file mode 100644 index 4f03d6331c3..00000000000 --- a/website/docs/api-reference/other/ResourceApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: ResourceApi -title: ResourceApi -sidebar_label: ResourceApi -sidebar_position: 12 ---- -# ResourceApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/other/ResourceApi#getAPIGroup) | **GET** /apis/resource.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ResourceApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/ResourceV1Api.md b/website/docs/api-reference/other/ResourceV1Api.md deleted file mode 100644 index f5608ee68dc..00000000000 --- a/website/docs/api-reference/other/ResourceV1Api.md +++ /dev/null @@ -1,4243 +0,0 @@ ---- -id: ResourceV1Api -title: ResourceV1Api -sidebar_label: ResourceV1Api -sidebar_position: 14 ---- -# ResourceV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](/docs/api-reference/other/ResourceV1Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1/deviceclasses | -[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](/docs/api-reference/other/ResourceV1Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1/resourceslices | -[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices | -[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**getAPIResources**](/docs/api-reference/other/ResourceV1Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1/ | -[**listDeviceClass**](/docs/api-reference/other/ResourceV1Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses | -[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaimtemplates | -[**listResourceSlice**](/docs/api-reference/other/ResourceV1Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices | -[**patchDeviceClass**](/docs/api-reference/other/ResourceV1Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](/docs/api-reference/other/ResourceV1Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**readDeviceClass**](/docs/api-reference/other/ResourceV1Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](/docs/api-reference/other/ResourceV1Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1/resourceslices/{name} | - -### createDeviceClass - - - -> V1DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaim - - - -> ResourceV1ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createResourceSlice - - - -> V1ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionDeviceClass - - - -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaim - - - -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaimTemplate - - - -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionResourceSlice - - - -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteDeviceClass - - - -> V1DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaim - - - -> ResourceV1ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteResourceSlice - - - -> V1ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeviceClass - - - -> V1DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DeviceClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaim - - - -> V1ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimForAllNamespaces - - - -> V1ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimTemplateForAllNamespaces - - - -> V1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceSlice - - - -> V1ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchDeviceClass - - - -> V1DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaim - - - -> ResourceV1ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimStatus - - - -> ResourceV1ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchResourceSlice - - - -> V1ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readDeviceClass - - - -> V1DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaim - - - -> ResourceV1ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimStatus - - - -> ResourceV1ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readResourceSlice - - - -> V1ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceDeviceClass - - - -> V1DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaim - - - -> ResourceV1ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimStatus - - - -> ResourceV1ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceResourceSlice - - - -> V1ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/ResourceV1alpha3Api.md b/website/docs/api-reference/other/ResourceV1alpha3Api.md deleted file mode 100644 index 422afac65e5..00000000000 --- a/website/docs/api-reference/other/ResourceV1alpha3Api.md +++ /dev/null @@ -1,1034 +0,0 @@ ---- -id: ResourceV1alpha3Api -title: ResourceV1alpha3Api -sidebar_label: ResourceV1alpha3Api -sidebar_position: 13 ---- -# ResourceV1alpha3Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#createDeviceTaintRule) | **POST** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**deleteCollectionDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#deleteCollectionDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**deleteDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#deleteDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**getAPIResources**](/docs/api-reference/other/ResourceV1alpha3Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1alpha3/ | -[**listDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#listDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**patchDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#patchDeviceTaintRule) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**patchDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#patchDeviceTaintRuleStatus) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | -[**readDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#readDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**readDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#readDeviceTaintRuleStatus) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | -[**replaceDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#replaceDeviceTaintRule) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**replaceDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#replaceDeviceTaintRuleStatus) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | - -### createDeviceTaintRule - - - -> V1alpha3DeviceTaintRule createDeviceTaintRule(body) - -create a DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiCreateDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiCreateDeviceTaintRuleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionDeviceTaintRule - - - -> V1Status deleteCollectionDeviceTaintRule() - -delete collection of DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteDeviceTaintRule - - - -> V1alpha3DeviceTaintRule deleteDeviceTaintRule() - -delete a DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeviceTaintRule - - - -> V1alpha3DeviceTaintRuleList listDeviceTaintRule() - -list or watch objects of kind DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiListDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiListDeviceTaintRuleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRuleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchDeviceTaintRule - - - -> V1alpha3DeviceTaintRule patchDeviceTaintRule(body) - -partially update the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiPatchDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiPatchDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchDeviceTaintRuleStatus - - - -> V1alpha3DeviceTaintRule patchDeviceTaintRuleStatus(body) - -partially update status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readDeviceTaintRule - - - -> V1alpha3DeviceTaintRule readDeviceTaintRule() - -read the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiReadDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReadDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readDeviceTaintRuleStatus - - - -> V1alpha3DeviceTaintRule readDeviceTaintRuleStatus() - -read status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceDeviceTaintRule - - - -> V1alpha3DeviceTaintRule replaceDeviceTaintRule(body) - -replace the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceDeviceTaintRuleStatus - - - -> V1alpha3DeviceTaintRule replaceDeviceTaintRuleStatus(body) - -replace status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/ResourceV1beta1Api.md b/website/docs/api-reference/other/ResourceV1beta1Api.md deleted file mode 100644 index 45b5addc503..00000000000 --- a/website/docs/api-reference/other/ResourceV1beta1Api.md +++ /dev/null @@ -1,4237 +0,0 @@ ---- -id: ResourceV1beta1Api -title: ResourceV1beta1Api -sidebar_label: ResourceV1beta1Api -sidebar_position: 15 ---- -# ResourceV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta1/resourceslices | -[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices | -[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**getAPIResources**](/docs/api-reference/other/ResourceV1beta1Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta1/ | -[**listDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1beta1Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1beta1Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaimtemplates | -[**listResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices | -[**patchDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**readDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | - -### createDeviceClass - - - -> V1beta1DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaim - - - -> V1beta1ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createResourceSlice - - - -> V1beta1ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - basic: { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - name: "name_example", - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionDeviceClass - - - -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaim - - - -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaimTemplate - - - -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionResourceSlice - - - -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteDeviceClass - - - -> V1beta1DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaim - - - -> V1beta1ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteResourceSlice - - - -> V1beta1ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeviceClass - - - -> V1beta1DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaim - - - -> V1beta1ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimForAllNamespaces - - - -> V1beta1ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimTemplateForAllNamespaces - - - -> V1beta1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceSlice - - - -> V1beta1ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchDeviceClass - - - -> V1beta1DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaim - - - -> V1beta1ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimStatus - - - -> V1beta1ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchResourceSlice - - - -> V1beta1ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readDeviceClass - - - -> V1beta1DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaim - - - -> V1beta1ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimStatus - - - -> V1beta1ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readResourceSlice - - - -> V1beta1ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceDeviceClass - - - -> V1beta1DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaim - - - -> V1beta1ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimStatus - - - -> V1beta1ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceResourceSlice - - - -> V1beta1ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - basic: { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - name: "name_example", - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/ResourceV1beta2Api.md b/website/docs/api-reference/other/ResourceV1beta2Api.md deleted file mode 100644 index 63718ec328b..00000000000 --- a/website/docs/api-reference/other/ResourceV1beta2Api.md +++ /dev/null @@ -1,4243 +0,0 @@ ---- -id: ResourceV1beta2Api -title: ResourceV1beta2Api -sidebar_label: ResourceV1beta2Api -sidebar_position: 16 ---- -# ResourceV1beta2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta2/resourceslices | -[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices | -[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**getAPIResources**](/docs/api-reference/other/ResourceV1beta2Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta2/ | -[**listDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1beta2Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1beta2Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaimtemplates | -[**listResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices | -[**patchDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**readDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | - -### createDeviceClass - - - -> V1beta2DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaim - - - -> V1beta2ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createResourceSlice - - - -> V1beta2ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionDeviceClass - - - -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaim - - - -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaimTemplate - - - -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionResourceSlice - - - -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteDeviceClass - - - -> V1beta2DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaim - - - -> V1beta2ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteResourceSlice - - - -> V1beta2ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeviceClass - - - -> V1beta2DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaim - - - -> V1beta2ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimForAllNamespaces - - - -> V1beta2ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimTemplateForAllNamespaces - - - -> V1beta2ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceSlice - - - -> V1beta2ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchDeviceClass - - - -> V1beta2DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaim - - - -> V1beta2ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimStatus - - - -> V1beta2ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchResourceSlice - - - -> V1beta2ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readDeviceClass - - - -> V1beta2DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaim - - - -> V1beta2ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimStatus - - - -> V1beta2ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readResourceSlice - - - -> V1beta2ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceDeviceClass - - - -> V1beta2DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaim - - - -> V1beta2ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimStatus - - - -> V1beta2ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceResourceSlice - - - -> V1beta2ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/VersionApi.md b/website/docs/api-reference/other/VersionApi.md deleted file mode 100644 index 4bcec0125a1..00000000000 --- a/website/docs/api-reference/other/VersionApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: VersionApi -title: VersionApi -sidebar_label: VersionApi -sidebar_position: 17 ---- -# VersionApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getCode**](/docs/api-reference/other/VersionApi#getCode) | **GET** /version/ | - -### getCode - - - -> VersionInfo getCode() - -get the version information for this server - -### Example - - -```typescript -import { createConfiguration, VersionApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new VersionApi(configuration); - -const request = {}; - -const data = await apiInstance.getCode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -VersionInfo - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/WellKnownApi.md b/website/docs/api-reference/other/WellKnownApi.md deleted file mode 100644 index e3550313146..00000000000 --- a/website/docs/api-reference/other/WellKnownApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: WellKnownApi -title: WellKnownApi -sidebar_label: WellKnownApi -sidebar_position: 18 ---- -# WellKnownApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getServiceAccountIssuerOpenIDConfiguration**](/docs/api-reference/other/WellKnownApi#getServiceAccountIssuerOpenIDConfiguration) | **GET** /.well-known/openid-configuration | - -### getServiceAccountIssuerOpenIDConfiguration - - - -> string getServiceAccountIssuerOpenIDConfiguration() - -get service account issuer OpenID configuration, also known as the \'OIDC discovery doc\' - -### Example - - -```typescript -import { createConfiguration, WellKnownApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new WellKnownApi(configuration); - -const request = {}; - -const data = await apiInstance.getServiceAccountIssuerOpenIDConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/other/_category_.json b/website/docs/api-reference/other/_category_.json deleted file mode 100644 index ea3276e897e..00000000000 --- a/website/docs/api-reference/other/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Other", - "position": 7 -} diff --git a/website/docs/api-reference/security/AuthenticationApi.md b/website/docs/api-reference/security/AuthenticationApi.md deleted file mode 100644 index 87462a1c002..00000000000 --- a/website/docs/api-reference/security/AuthenticationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AuthenticationApi -title: AuthenticationApi -sidebar_label: AuthenticationApi -sidebar_position: 1 ---- -# AuthenticationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/security/AuthenticationApi#getAPIGroup) | **GET** /apis/authentication.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AuthenticationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/AuthenticationV1Api.md b/website/docs/api-reference/security/AuthenticationV1Api.md deleted file mode 100644 index ea08df6db06..00000000000 --- a/website/docs/api-reference/security/AuthenticationV1Api.md +++ /dev/null @@ -1,329 +0,0 @@ ---- -id: AuthenticationV1Api -title: AuthenticationV1Api -sidebar_label: AuthenticationV1Api -sidebar_position: 2 ---- -# AuthenticationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createSelfSubjectReview**](/docs/api-reference/security/AuthenticationV1Api#createSelfSubjectReview) | **POST** /apis/authentication.k8s.io/v1/selfsubjectreviews | -[**createTokenReview**](/docs/api-reference/security/AuthenticationV1Api#createTokenReview) | **POST** /apis/authentication.k8s.io/v1/tokenreviews | -[**getAPIResources**](/docs/api-reference/security/AuthenticationV1Api#getAPIResources) | **GET** /apis/authentication.k8s.io/v1/ | - -### createSelfSubjectReview - - - -> V1SelfSubjectReview createSelfSubjectReview(body) - -create a SelfSubjectReview - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; -import type { AuthenticationV1ApiCreateSelfSubjectReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request: AuthenticationV1ApiCreateSelfSubjectReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - status: { - userInfo: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - uid: "uid_example", - username: "username_example", - }, - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1SelfSubjectReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createTokenReview - - - -> V1TokenReview createTokenReview(body) - -create a TokenReview - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; -import type { AuthenticationV1ApiCreateTokenReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request: AuthenticationV1ApiCreateTokenReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - audiences: [ - "audiences_example", - ], - token: "token_example", - }, - status: { - audiences: [ - "audiences_example", - ], - authenticated: true, - error: "error_example", - user: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - uid: "uid_example", - username: "username_example", - }, - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createTokenReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1TokenReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1TokenReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/AuthorizationApi.md b/website/docs/api-reference/security/AuthorizationApi.md deleted file mode 100644 index 8a455c1507a..00000000000 --- a/website/docs/api-reference/security/AuthorizationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AuthorizationApi -title: AuthorizationApi -sidebar_label: AuthorizationApi -sidebar_position: 3 ---- -# AuthorizationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/security/AuthorizationApi#getAPIGroup) | **GET** /apis/authorization.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AuthorizationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/AuthorizationV1Api.md b/website/docs/api-reference/security/AuthorizationV1Api.md deleted file mode 100644 index f93a906688b..00000000000 --- a/website/docs/api-reference/security/AuthorizationV1Api.md +++ /dev/null @@ -1,709 +0,0 @@ ---- -id: AuthorizationV1Api -title: AuthorizationV1Api -sidebar_label: AuthorizationV1Api -sidebar_position: 4 ---- -# AuthorizationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLocalSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createNamespacedLocalSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews | -[**createSelfSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createSelfSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectaccessreviews | -[**createSelfSubjectRulesReview**](/docs/api-reference/security/AuthorizationV1Api#createSelfSubjectRulesReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectrulesreviews | -[**createSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/subjectaccessreviews | -[**getAPIResources**](/docs/api-reference/security/AuthorizationV1Api#getAPIResources) | **GET** /apis/authorization.k8s.io/v1/ | - -### createNamespacedLocalSubjectAccessReview - - - -> V1LocalSubjectAccessReview createNamespacedLocalSubjectAccessReview(body) - -create a LocalSubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; -import type { AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - uid: "uid_example", - user: "user_example", - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedLocalSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LocalSubjectAccessReview**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1LocalSubjectAccessReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createSelfSubjectAccessReview - - - -> V1SelfSubjectAccessReview createSelfSubjectAccessReview(body) - -create a SelfSubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; -import type { AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectAccessReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1SelfSubjectAccessReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createSelfSubjectRulesReview - - - -> V1SelfSubjectRulesReview createSelfSubjectRulesReview(body) - -create a SelfSubjectRulesReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; -import type { AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - namespace: "namespace_example", - }, - status: { - evaluationError: "evaluationError_example", - incomplete: true, - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectRulesReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectRulesReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1SelfSubjectRulesReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createSubjectAccessReview - - - -> V1SubjectAccessReview createSubjectAccessReview(body) - -create a SubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; -import type { AuthorizationV1ApiCreateSubjectAccessReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSubjectAccessReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - uid: "uid_example", - user: "user_example", - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SubjectAccessReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1SubjectAccessReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/CertificatesApi.md b/website/docs/api-reference/security/CertificatesApi.md deleted file mode 100644 index 64655347e16..00000000000 --- a/website/docs/api-reference/security/CertificatesApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: CertificatesApi -title: CertificatesApi -sidebar_label: CertificatesApi -sidebar_position: 5 ---- -# CertificatesApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/security/CertificatesApi#getAPIGroup) | **GET** /apis/certificates.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, CertificatesApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/CertificatesV1Api.md b/website/docs/api-reference/security/CertificatesV1Api.md deleted file mode 100644 index 115c9de03cb..00000000000 --- a/website/docs/api-reference/security/CertificatesV1Api.md +++ /dev/null @@ -1,1331 +0,0 @@ ---- -id: CertificatesV1Api -title: CertificatesV1Api -sidebar_label: CertificatesV1Api -sidebar_position: 7 ---- -# CertificatesV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#createCertificateSigningRequest) | **POST** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**deleteCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#deleteCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**deleteCollectionCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#deleteCollectionCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**getAPIResources**](/docs/api-reference/security/CertificatesV1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1/ | -[**listCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#listCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**patchCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequest) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**patchCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequestApproval) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**patchCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | -[**readCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**readCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequestApproval) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**readCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequestStatus) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | -[**replaceCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequest) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**replaceCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequestApproval) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**replaceCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequestStatus) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | - -### createCertificateSigningRequest - - - -> V1CertificateSigningRequest createCertificateSigningRequest(body) - -create a CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiCreateCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiCreateCertificateSigningRequestRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCertificateSigningRequest - - - -> V1Status deleteCertificateSigningRequest() - -delete a CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiDeleteCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiDeleteCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionCertificateSigningRequest - - - -> V1Status deleteCollectionCertificateSigningRequest() - -delete collection of CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCertificateSigningRequest - - - -> V1CertificateSigningRequestList listCertificateSigningRequest() - -list or watch objects of kind CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiListCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiListCertificateSigningRequestRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequestList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchCertificateSigningRequest - - - -> V1CertificateSigningRequest patchCertificateSigningRequest(body) - -partially update the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiPatchCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchCertificateSigningRequestApproval - - - -> V1CertificateSigningRequest patchCertificateSigningRequestApproval(body) - -partially update approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchCertificateSigningRequestStatus - - - -> V1CertificateSigningRequest patchCertificateSigningRequestStatus(body) - -partially update status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiPatchCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readCertificateSigningRequest - - - -> V1CertificateSigningRequest readCertificateSigningRequest() - -read the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReadCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readCertificateSigningRequestApproval - - - -> V1CertificateSigningRequest readCertificateSigningRequestApproval() - -read approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReadCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readCertificateSigningRequestStatus - - - -> V1CertificateSigningRequest readCertificateSigningRequestStatus() - -read status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReadCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceCertificateSigningRequest - - - -> V1CertificateSigningRequest replaceCertificateSigningRequest(body) - -replace the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReplaceCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceCertificateSigningRequestApproval - - - -> V1CertificateSigningRequest replaceCertificateSigningRequestApproval(body) - -replace approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceCertificateSigningRequestStatus - - - -> V1CertificateSigningRequest replaceCertificateSigningRequestStatus(body) - -replace status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/CertificatesV1alpha1Api.md b/website/docs/api-reference/security/CertificatesV1alpha1Api.md deleted file mode 100644 index 3d8fd7a66b4..00000000000 --- a/website/docs/api-reference/security/CertificatesV1alpha1Api.md +++ /dev/null @@ -1,719 +0,0 @@ ---- -id: CertificatesV1alpha1Api -title: CertificatesV1alpha1Api -sidebar_label: CertificatesV1alpha1Api -sidebar_position: 6 ---- -# CertificatesV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**deleteClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**deleteCollectionClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**getAPIResources**](/docs/api-reference/security/CertificatesV1alpha1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1alpha1/ | -[**listClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**patchClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**readClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**replaceClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | - -### createClusterTrustBundle - - - -> V1alpha1ClusterTrustBundle createClusterTrustBundle(body) - -create a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiCreateClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiCreateClusterTrustBundleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ClusterTrustBundle**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteClusterTrustBundle - - - -> V1Status deleteClusterTrustBundle() - -delete a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterTrustBundle - - - -> V1Status deleteCollectionClusterTrustBundle() - -delete collection of ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterTrustBundle - - - -> V1alpha1ClusterTrustBundleList listClusterTrustBundle() - -list or watch objects of kind ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiListClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiListClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterTrustBundle - - - -> V1alpha1ClusterTrustBundle patchClusterTrustBundle(body) - -partially update the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiPatchClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiPatchClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readClusterTrustBundle - - - -> V1alpha1ClusterTrustBundle readClusterTrustBundle() - -read the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiReadClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiReadClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterTrustBundle - - - -> V1alpha1ClusterTrustBundle replaceClusterTrustBundle(body) - -replace the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ClusterTrustBundle**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/CertificatesV1beta1Api.md b/website/docs/api-reference/security/CertificatesV1beta1Api.md deleted file mode 100644 index 5cef2659fca..00000000000 --- a/website/docs/api-reference/security/CertificatesV1beta1Api.md +++ /dev/null @@ -1,1824 +0,0 @@ ---- -id: CertificatesV1beta1Api -title: CertificatesV1beta1Api -sidebar_label: CertificatesV1beta1Api -sidebar_position: 8 ---- -# CertificatesV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**createNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#createNamespacedPodCertificateRequest) | **POST** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**deleteClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**deleteCollectionClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**deleteCollectionNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#deleteCollectionNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**deleteNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#deleteNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**getAPIResources**](/docs/api-reference/security/CertificatesV1beta1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1beta1/ | -[**listClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**listNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#listNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**listPodCertificateRequestForAllNamespaces**](/docs/api-reference/security/CertificatesV1beta1Api#listPodCertificateRequestForAllNamespaces) | **GET** /apis/certificates.k8s.io/v1beta1/podcertificaterequests | -[**patchClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**patchNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#patchNamespacedPodCertificateRequest) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**patchNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#patchNamespacedPodCertificateRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | -[**readClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**readNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#readNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**readNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#readNamespacedPodCertificateRequestStatus) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | -[**replaceClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**replaceNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#replaceNamespacedPodCertificateRequest) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**replaceNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#replaceNamespacedPodCertificateRequestStatus) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | - -### createClusterTrustBundle - - - -> V1beta1ClusterTrustBundle createClusterTrustBundle(body) - -create a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiCreateClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiCreateClusterTrustBundleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ClusterTrustBundle**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequest createNamespacedPodCertificateRequest(body) - -create a PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteClusterTrustBundle - - - -> V1Status deleteClusterTrustBundle() - -delete a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiDeleteClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterTrustBundle - - - -> V1Status deleteCollectionClusterTrustBundle() - -delete collection of ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPodCertificateRequest - - - -> V1Status deleteCollectionNamespacedPodCertificateRequest() - -delete collection of PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedPodCertificateRequest - - - -> V1Status deleteNamespacedPodCertificateRequest() - -delete a PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterTrustBundle - - - -> V1beta1ClusterTrustBundleList listClusterTrustBundle() - -list or watch objects of kind ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiListClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequestList listNamespacedPodCertificateRequest() - -list or watch objects of kind PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequestList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPodCertificateRequestForAllNamespaces - - - -> V1beta1PodCertificateRequestList listPodCertificateRequestForAllNamespaces() - -list or watch objects of kind PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodCertificateRequestForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequestList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterTrustBundle - - - -> V1beta1ClusterTrustBundle patchClusterTrustBundle(body) - -partially update the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiPatchClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequest(body) - -partially update the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodCertificateRequestStatus - - - -> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequestStatus(body) - -partially update status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readClusterTrustBundle - - - -> V1beta1ClusterTrustBundle readClusterTrustBundle() - -read the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReadClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequest readNamespacedPodCertificateRequest() - -read the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodCertificateRequestStatus - - - -> V1beta1PodCertificateRequest readNamespacedPodCertificateRequestStatus() - -read status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterTrustBundle - - - -> V1beta1ClusterTrustBundle replaceClusterTrustBundle(body) - -replace the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReplaceClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ClusterTrustBundle**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequest(body) - -replace the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodCertificateRequestStatus - - - -> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequestStatus(body) - -replace status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/RbacAuthorizationApi.md b/website/docs/api-reference/security/RbacAuthorizationApi.md deleted file mode 100644 index 02f45f4fa0c..00000000000 --- a/website/docs/api-reference/security/RbacAuthorizationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: RbacAuthorizationApi -title: RbacAuthorizationApi -sidebar_label: RbacAuthorizationApi -sidebar_position: 9 ---- -# RbacAuthorizationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/security/RbacAuthorizationApi#getAPIGroup) | **GET** /apis/rbac.authorization.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/RbacAuthorizationV1Api.md b/website/docs/api-reference/security/RbacAuthorizationV1Api.md deleted file mode 100644 index 84755290f3d..00000000000 --- a/website/docs/api-reference/security/RbacAuthorizationV1Api.md +++ /dev/null @@ -1,3034 +0,0 @@ ---- -id: RbacAuthorizationV1Api -title: RbacAuthorizationV1Api -sidebar_label: RbacAuthorizationV1Api -sidebar_position: 10 ---- -# RbacAuthorizationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#createClusterRole) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**createClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#createClusterRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**createNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#createNamespacedRole) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**createNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#createNamespacedRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**deleteClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**deleteClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**deleteCollectionClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**deleteCollectionClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**deleteCollectionNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**deleteCollectionNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**deleteNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**deleteNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**getAPIResources**](/docs/api-reference/security/RbacAuthorizationV1Api#getAPIResources) | **GET** /apis/rbac.authorization.k8s.io/v1/ | -[**listClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#listClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**listClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#listClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**listNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#listNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**listNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#listNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**listRoleBindingForAllNamespaces**](/docs/api-reference/security/RbacAuthorizationV1Api#listRoleBindingForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/rolebindings | -[**listRoleForAllNamespaces**](/docs/api-reference/security/RbacAuthorizationV1Api#listRoleForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/roles | -[**patchClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#patchClusterRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**patchClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#patchClusterRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**patchNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#patchNamespacedRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**patchNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#patchNamespacedRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**readClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#readClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**readClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#readClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**readNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#readNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**readNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#readNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**replaceClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceClusterRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**replaceClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceClusterRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**replaceNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceNamespacedRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**replaceNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceNamespacedRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | - -### createClusterRole - - - -> V1ClusterRole createClusterRole(body) - -create a ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiCreateClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateClusterRoleRequest = { - - body: { - aggregationRule: { - clusterRoleSelectors: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - ], - }, - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRole**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ClusterRole - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createClusterRoleBinding - - - -> V1ClusterRoleBinding createClusterRoleBinding(body) - -create a ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiCreateClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateClusterRoleBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRoleBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedRole - - - -> V1Role createNamespacedRole(body) - -create a Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiCreateNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Role**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Role - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedRoleBinding - - - -> V1RoleBinding createNamespacedRoleBinding(body) - -create a RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RoleBinding**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1RoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteClusterRole - - - -> V1Status deleteClusterRole() - -delete a ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteClusterRoleBinding - - - -> V1Status deleteClusterRoleBinding() - -delete a ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterRole - - - -> V1Status deleteCollectionClusterRole() - -delete collection of ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterRoleBinding - - - -> V1Status deleteCollectionClusterRoleBinding() - -delete collection of ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedRole - - - -> V1Status deleteCollectionNamespacedRole() - -delete collection of Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedRoleBinding - - - -> V1Status deleteCollectionNamespacedRoleBinding() - -delete collection of RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedRole - - - -> V1Status deleteNamespacedRole() - -delete a Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedRoleBinding - - - -> V1Status deleteNamespacedRoleBinding() - -delete a RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterRole - - - -> V1ClusterRoleList listClusterRole() - -list or watch objects of kind ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListClusterRoleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterRoleBinding - - - -> V1ClusterRoleBindingList listClusterRoleBinding() - -list or watch objects of kind ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListClusterRoleBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedRole - - - -> V1RoleList listNamespacedRole() - -list or watch objects of kind Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RoleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedRoleBinding - - - -> V1RoleBindingList listNamespacedRoleBinding() - -list or watch objects of kind RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RoleBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listRoleBindingForAllNamespaces - - - -> V1RoleBindingList listRoleBindingForAllNamespaces() - -list or watch objects of kind RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRoleBindingForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RoleBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listRoleForAllNamespaces - - - -> V1RoleList listRoleForAllNamespaces() - -list or watch objects of kind Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListRoleForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListRoleForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRoleForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RoleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterRole - - - -> V1ClusterRole patchClusterRole(body) - -partially update the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiPatchClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ClusterRole - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchClusterRoleBinding - - - -> V1ClusterRoleBinding patchClusterRoleBinding(body) - -partially update the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiPatchClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedRole - - - -> V1Role patchNamespacedRole(body) - -partially update the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiPatchNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Role - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedRoleBinding - - - -> V1RoleBinding patchNamespacedRoleBinding(body) - -partially update the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1RoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readClusterRole - - - -> V1ClusterRole readClusterRole() - -read the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReadClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ClusterRole - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readClusterRoleBinding - - - -> V1ClusterRoleBinding readClusterRoleBinding() - -read the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReadClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedRole - - - -> V1Role readNamespacedRole() - -read the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReadNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Role - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedRoleBinding - - - -> V1RoleBinding readNamespacedRoleBinding() - -read the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1RoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterRole - - - -> V1ClusterRole replaceClusterRole(body) - -replace the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReplaceClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - - body: { - aggregationRule: { - clusterRoleSelectors: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - ], - }, - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRole**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ClusterRole - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceClusterRoleBinding - - - -> V1ClusterRoleBinding replaceClusterRoleBinding(body) - -replace the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRoleBinding**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedRole - - - -> V1Role replaceNamespacedRole(body) - -replace the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReplaceNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Role**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Role - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedRoleBinding - - - -> V1RoleBinding replaceNamespacedRoleBinding(body) - -replace the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RoleBinding**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1RoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/security/_category_.json b/website/docs/api-reference/security/_category_.json deleted file mode 100644 index 45fba4709cc..00000000000 --- a/website/docs/api-reference/security/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Security", - "position": 4 -} diff --git a/website/docs/api-reference/workloads/AppsApi.md b/website/docs/api-reference/workloads/AppsApi.md deleted file mode 100644 index ca768916c31..00000000000 --- a/website/docs/api-reference/workloads/AppsApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AppsApi -title: AppsApi -sidebar_label: AppsApi -sidebar_position: 1 ---- -# AppsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/workloads/AppsApi#getAPIGroup) | **GET** /apis/apps/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AppsApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/workloads/AppsV1Api.md b/website/docs/api-reference/workloads/AppsV1Api.md deleted file mode 100644 index 61a75520691..00000000000 --- a/website/docs/api-reference/workloads/AppsV1Api.md +++ /dev/null @@ -1,28122 +0,0 @@ ---- -id: AppsV1Api -title: AppsV1Api -sidebar_label: AppsV1Api -sidebar_position: 2 ---- -# AppsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#createNamespacedControllerRevision) | **POST** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**createNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedDaemonSet) | **POST** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**createNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#createNamespacedDeployment) | **POST** /apis/apps/v1/namespaces/{namespace}/deployments | -[**createNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedReplicaSet) | **POST** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**createNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedStatefulSet) | **POST** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**deleteCollectionNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**deleteCollectionNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**deleteCollectionNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments | -[**deleteCollectionNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**deleteCollectionNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**deleteNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**deleteNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**deleteNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**deleteNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**deleteNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**getAPIResources**](/docs/api-reference/workloads/AppsV1Api#getAPIResources) | **GET** /apis/apps/v1/ | -[**listControllerRevisionForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listControllerRevisionForAllNamespaces) | **GET** /apis/apps/v1/controllerrevisions | -[**listDaemonSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listDaemonSetForAllNamespaces) | **GET** /apis/apps/v1/daemonsets | -[**listDeploymentForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listDeploymentForAllNamespaces) | **GET** /apis/apps/v1/deployments | -[**listNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#listNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**listNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**listNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#listNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments | -[**listNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**listNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**listReplicaSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listReplicaSetForAllNamespaces) | **GET** /apis/apps/v1/replicasets | -[**listStatefulSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listStatefulSetForAllNamespaces) | **GET** /apis/apps/v1/statefulsets | -[**patchNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedControllerRevision) | **PATCH** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**patchNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDaemonSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**patchNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDaemonSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**patchNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeployment) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**patchNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeploymentScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**patchNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeploymentStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**patchNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**patchNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**patchNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**patchNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**patchNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**patchNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | -[**readNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#readNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**readNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**readNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDaemonSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**readNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**readNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeploymentScale) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**readNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeploymentStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**readNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**readNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**readNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**readNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**readNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**readNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | -[**replaceNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedControllerRevision) | **PUT** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**replaceNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDaemonSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**replaceNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDaemonSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**replaceNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeployment) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**replaceNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeploymentScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**replaceNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeploymentStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**replaceNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**replaceNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**replaceNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**replaceNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**replaceNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**replaceNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | - -### createNamespacedControllerRevision - - - -> V1ControllerRevision createNamespacedControllerRevision(body) - -create a ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: {}, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - revision: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ControllerRevision**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ControllerRevision - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedDaemonSet - - - -> V1DaemonSet createNamespacedDaemonSet(body) - -create a DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedDeployment - - - -> V1Deployment createNamespacedDeployment(body) - -create a Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedReplicaSet - - - -> V1ReplicaSet createNamespacedReplicaSet(body) - -create a ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedStatefulSet - - - -> V1StatefulSet createNamespacedStatefulSet(body) - -create a StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedControllerRevision - - - -> V1Status deleteCollectionNamespacedControllerRevision() - -delete collection of ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedDaemonSet - - - -> V1Status deleteCollectionNamespacedDaemonSet() - -delete collection of DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedDeployment - - - -> V1Status deleteCollectionNamespacedDeployment() - -delete collection of Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedReplicaSet - - - -> V1Status deleteCollectionNamespacedReplicaSet() - -delete collection of ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedStatefulSet - - - -> V1Status deleteCollectionNamespacedStatefulSet() - -delete collection of StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedControllerRevision - - - -> V1Status deleteNamespacedControllerRevision() - -delete a ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedDaemonSet - - - -> V1Status deleteNamespacedDaemonSet() - -delete a DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedDeployment - - - -> V1Status deleteNamespacedDeployment() - -delete a Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedReplicaSet - - - -> V1Status deleteNamespacedReplicaSet() - -delete a ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedStatefulSet - - - -> V1Status deleteNamespacedStatefulSet() - -delete a StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listControllerRevisionForAllNamespaces - - - -> V1ControllerRevisionList listControllerRevisionForAllNamespaces() - -list or watch objects of kind ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListControllerRevisionForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListControllerRevisionForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listControllerRevisionForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ControllerRevisionList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDaemonSetForAllNamespaces - - - -> V1DaemonSetList listDaemonSetForAllNamespaces() - -list or watch objects of kind DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListDaemonSetForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListDaemonSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDaemonSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DaemonSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeploymentForAllNamespaces - - - -> V1DeploymentList listDeploymentForAllNamespaces() - -list or watch objects of kind Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListDeploymentForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListDeploymentForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeploymentForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DeploymentList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedControllerRevision - - - -> V1ControllerRevisionList listNamespacedControllerRevision() - -list or watch objects of kind ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ControllerRevisionList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedDaemonSet - - - -> V1DaemonSetList listNamespacedDaemonSet() - -list or watch objects of kind DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DaemonSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedDeployment - - - -> V1DeploymentList listNamespacedDeployment() - -list or watch objects of kind Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DeploymentList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedReplicaSet - - - -> V1ReplicaSetList listNamespacedReplicaSet() - -list or watch objects of kind ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ReplicaSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedStatefulSet - - - -> V1StatefulSetList listNamespacedStatefulSet() - -list or watch objects of kind StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1StatefulSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listReplicaSetForAllNamespaces - - - -> V1ReplicaSetList listReplicaSetForAllNamespaces() - -list or watch objects of kind ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListReplicaSetForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListReplicaSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listReplicaSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ReplicaSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listStatefulSetForAllNamespaces - - - -> V1StatefulSetList listStatefulSetForAllNamespaces() - -list or watch objects of kind StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListStatefulSetForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListStatefulSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStatefulSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1StatefulSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedControllerRevision - - - -> V1ControllerRevision patchNamespacedControllerRevision(body) - -partially update the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ControllerRevision - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDaemonSet - - - -> V1DaemonSet patchNamespacedDaemonSet(body) - -partially update the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDaemonSetStatus - - - -> V1DaemonSet patchNamespacedDaemonSetStatus(body) - -partially update status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDeployment - - - -> V1Deployment patchNamespacedDeployment(body) - -partially update the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDeploymentScale - - - -> V1Scale patchNamespacedDeploymentScale(body) - -partially update scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDeploymentStatus - - - -> V1Deployment patchNamespacedDeploymentStatus(body) - -partially update status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicaSet - - - -> V1ReplicaSet patchNamespacedReplicaSet(body) - -partially update the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicaSetScale - - - -> V1Scale patchNamespacedReplicaSetScale(body) - -partially update scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicaSetStatus - - - -> V1ReplicaSet patchNamespacedReplicaSetStatus(body) - -partially update status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedStatefulSet - - - -> V1StatefulSet patchNamespacedStatefulSet(body) - -partially update the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedStatefulSetScale - - - -> V1Scale patchNamespacedStatefulSetScale(body) - -partially update scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedStatefulSetStatus - - - -> V1StatefulSet patchNamespacedStatefulSetStatus(body) - -partially update status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedControllerRevision - - - -> V1ControllerRevision readNamespacedControllerRevision() - -read the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ControllerRevision - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDaemonSet - - - -> V1DaemonSet readNamespacedDaemonSet() - -read the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDaemonSetStatus - - - -> V1DaemonSet readNamespacedDaemonSetStatus() - -read status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDeployment - - - -> V1Deployment readNamespacedDeployment() - -read the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDeploymentScale - - - -> V1Scale readNamespacedDeploymentScale() - -read scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDeploymentStatus - - - -> V1Deployment readNamespacedDeploymentStatus() - -read status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicaSet - - - -> V1ReplicaSet readNamespacedReplicaSet() - -read the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicaSetScale - - - -> V1Scale readNamespacedReplicaSetScale() - -read scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicaSetStatus - - - -> V1ReplicaSet readNamespacedReplicaSetStatus() - -read status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedStatefulSet - - - -> V1StatefulSet readNamespacedStatefulSet() - -read the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedStatefulSetScale - - - -> V1Scale readNamespacedStatefulSetScale() - -read scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedStatefulSetStatus - - - -> V1StatefulSet readNamespacedStatefulSetStatus() - -read status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedControllerRevision - - - -> V1ControllerRevision replaceNamespacedControllerRevision(body) - -replace the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: {}, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - revision: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ControllerRevision**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ControllerRevision - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDaemonSet - - - -> V1DaemonSet replaceNamespacedDaemonSet(body) - -replace the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDaemonSetStatus - - - -> V1DaemonSet replaceNamespacedDaemonSetStatus(body) - -replace status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDeployment - - - -> V1Deployment replaceNamespacedDeployment(body) - -replace the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDeploymentScale - - - -> V1Scale replaceNamespacedDeploymentScale(body) - -replace scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDeploymentStatus - - - -> V1Deployment replaceNamespacedDeploymentStatus(body) - -replace status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicaSet - - - -> V1ReplicaSet replaceNamespacedReplicaSet(body) - -replace the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicaSetScale - - - -> V1Scale replaceNamespacedReplicaSetScale(body) - -replace scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicaSetStatus - - - -> V1ReplicaSet replaceNamespacedReplicaSetStatus(body) - -replace status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedStatefulSet - - - -> V1StatefulSet replaceNamespacedStatefulSet(body) - -replace the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedStatefulSetScale - - - -> V1Scale replaceNamespacedStatefulSetScale(body) - -replace scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedStatefulSetStatus - - - -> V1StatefulSet replaceNamespacedStatefulSetStatus(body) - -replace status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/workloads/BatchApi.md b/website/docs/api-reference/workloads/BatchApi.md deleted file mode 100644 index 6eecc6c2da6..00000000000 --- a/website/docs/api-reference/workloads/BatchApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: BatchApi -title: BatchApi -sidebar_label: BatchApi -sidebar_position: 3 ---- -# BatchApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/workloads/BatchApi#getAPIGroup) | **GET** /apis/batch/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, BatchApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/workloads/BatchV1Api.md b/website/docs/api-reference/workloads/BatchV1Api.md deleted file mode 100644 index 3a672c79b93..00000000000 --- a/website/docs/api-reference/workloads/BatchV1Api.md +++ /dev/null @@ -1,13489 +0,0 @@ ---- -id: BatchV1Api -title: BatchV1Api -sidebar_label: BatchV1Api -sidebar_position: 4 ---- -# BatchV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#createNamespacedCronJob) | **POST** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**createNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#createNamespacedJob) | **POST** /apis/batch/v1/namespaces/{namespace}/jobs | -[**deleteCollectionNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#deleteCollectionNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**deleteCollectionNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#deleteCollectionNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs | -[**deleteNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#deleteNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**deleteNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#deleteNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**getAPIResources**](/docs/api-reference/workloads/BatchV1Api#getAPIResources) | **GET** /apis/batch/v1/ | -[**listCronJobForAllNamespaces**](/docs/api-reference/workloads/BatchV1Api#listCronJobForAllNamespaces) | **GET** /apis/batch/v1/cronjobs | -[**listJobForAllNamespaces**](/docs/api-reference/workloads/BatchV1Api#listJobForAllNamespaces) | **GET** /apis/batch/v1/jobs | -[**listNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#listNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**listNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#listNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs | -[**patchNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedCronJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**patchNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedCronJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**patchNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**patchNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | -[**readNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#readNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**readNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#readNamespacedCronJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**readNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#readNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**readNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#readNamespacedJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | -[**replaceNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedCronJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**replaceNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedCronJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**replaceNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**replaceNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | - -### createNamespacedCronJob - - - -> V1CronJob createNamespacedCronJob(body) - -create a CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiCreateNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiCreateNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedJob - - - -> V1Job createNamespacedJob(body) - -create a Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiCreateNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiCreateNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedCronJob - - - -> V1Status deleteCollectionNamespacedCronJob() - -delete collection of CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiDeleteCollectionNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteCollectionNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedJob - - - -> V1Status deleteCollectionNamespacedJob() - -delete collection of Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiDeleteCollectionNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteCollectionNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedCronJob - - - -> V1Status deleteNamespacedCronJob() - -delete a CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiDeleteNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedJob - - - -> V1Status deleteNamespacedJob() - -delete a Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiDeleteNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCronJobForAllNamespaces - - - -> V1CronJobList listCronJobForAllNamespaces() - -list or watch objects of kind CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiListCronJobForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListCronJobForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCronJobForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CronJobList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listJobForAllNamespaces - - - -> V1JobList listJobForAllNamespaces() - -list or watch objects of kind Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiListJobForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListJobForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listJobForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1JobList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedCronJob - - - -> V1CronJobList listNamespacedCronJob() - -list or watch objects of kind CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiListNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CronJobList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedJob - - - -> V1JobList listNamespacedJob() - -list or watch objects of kind Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiListNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1JobList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedCronJob - - - -> V1CronJob patchNamespacedCronJob(body) - -partially update the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiPatchNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedCronJobStatus - - - -> V1CronJob patchNamespacedCronJobStatus(body) - -partially update status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiPatchNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedJob - - - -> V1Job patchNamespacedJob(body) - -partially update the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiPatchNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedJobStatus - - - -> V1Job patchNamespacedJobStatus(body) - -partially update status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiPatchNamespacedJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedCronJob - - - -> V1CronJob readNamespacedCronJob() - -read the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReadNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedCronJobStatus - - - -> V1CronJob readNamespacedCronJobStatus() - -read status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReadNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedJob - - - -> V1Job readNamespacedJob() - -read the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReadNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedJobStatus - - - -> V1Job readNamespacedJobStatus() - -read status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReadNamespacedJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedCronJob - - - -> V1CronJob replaceNamespacedCronJob(body) - -replace the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReplaceNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedCronJobStatus - - - -> V1CronJob replaceNamespacedCronJobStatus(body) - -replace status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReplaceNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedJob - - - -> V1Job replaceNamespacedJob(body) - -replace the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReplaceNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedJobStatus - - - -> V1Job replaceNamespacedJobStatus(body) - -replace status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReplaceNamespacedJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/docs/api-reference/workloads/_category_.json b/website/docs/api-reference/workloads/_category_.json deleted file mode 100644 index 6f2c7368745..00000000000 --- a/website/docs/api-reference/workloads/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Workloads", - "position": 2 -} diff --git a/website/docs/intro.md b/website/docs/intro.md index 88f95714453..a8103187d34 100644 --- a/website/docs/intro.md +++ b/website/docs/intro.md @@ -2,46 +2,80 @@ sidebar_position: 1 --- -# Tutorial Intro +# Introduction -Let's discover **Docusaurus in less than 5 minutes**. +The Kubernetes JavaScript Client is the official Node.js client for interacting with Kubernetes clusters. It's written in TypeScript and provides a powerful, type-safe way to manage Kubernetes resources from your Node.js applications. -## Getting Started +## Installation -Get started by **creating a new site**. +Install the client using npm: -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. +```bash +npm install @kubernetes/client-node +``` -### What you'll need +## Quick Start -- [Node.js](https://nodejs.org/en/download/) version 20.0 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. +The following example shows how to load your default KubeConfig and list all pods in the `default` namespace. -## Generate a new site +```typescript +import * as k8s from '@kubernetes/client-node'; -Generate a new Docusaurus site using the **classic template**. +const kc = new k8s.KubeConfig(); +kc.loadFromDefault(); -The classic template will automatically be added to your project after you run the command: +const k8sApi = kc.makeApiClient(k8s.CoreV1Api); -```bash -npm init docusaurus@latest my-website classic +async function listPods() { + try { + const res = await k8sApi.listNamespacedPod({ namespace: 'default' }); + console.log( + 'Pods:', + res.items.map((pod) => pod.metadata?.name), + ); + } catch (err) { + console.error('Error:', err); + } +} + +listPods(); ``` -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. +## KubeConfig Methods -The command also installs all necessary dependencies you need to run Docusaurus. +The `KubeConfig` class provides several ways to load your configuration: -## Start your site +- `loadFromDefault()`: Loads from the default location (`~/.kube/config` or service account) +- `loadFromFile(path)`: Loads from a specific file +- `loadFromString(content)`: Loads from a YAML string +- `loadFromOptions(options)`: Loads from a programmatic object +- `loadFromCluster()`: Specifically for running inside a cluster (Service Account) -Run the development server: +## Compatibility -```bash -cd my-website -npm run start -``` +Starting with release `0.13.0`, the minor version of this library tracks the minor Kubernetes API version it was generated from. + +| client version | older versions | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 | 1.33 | 1.34 | +| -------------- | -------------- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | +| 0.19.x | - | ✓ | x | x | x | x | x | x | +| 0.20.x | - | + | ✓ | x | x | x | x | x | +| 0.21.x | - | + | + | ✓ | x | x | x | x | +| 0.22.x | - | + | + | + | ✓ | x | x | x | +| 1.0.x | - | + | + | + | + | ✓ | x | x | +| 1.1.x | - | + | + | + | + | ✓ | x | x | +| 1.2.x | - | + | + | + | + | + | ✓ | x | +| 1.3.x | - | + | + | + | + | + | ✓ | x | +| 1.4.x | - | + | + | + | + | + | + | ✓ | + +**Key:** -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. +- `✓` Exactly the same features / API objects. +- `+` Client has more features than the cluster, common features work. +- `-` Cluster has features client can't use yet. +- `x` No guarantee of support (outside the n-2 version support window). -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. +## Links -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. +- [SDK Reference](/docs/sdk) +- [Kubernetes API Reference](https://kubernetes.io/docs/reference/) +- [GitHub Repository](https://github.com/kubernetes-client/javascript) diff --git a/website/docs/sdk/attach/classes/Attach.md b/website/docs/sdk/attach/classes/Attach.md deleted file mode 100644 index 47ff766ad93..00000000000 --- a/website/docs/sdk/attach/classes/Attach.md +++ /dev/null @@ -1,75 +0,0 @@ -# Class: Attach - -Defined in: [src/attach.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/attach.ts#L9) - -## Constructors - -### Constructor - -> **new Attach**(`config`, `websocketInterface?`): `Attach` - -Defined in: [src/attach.ts:14](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/attach.ts#L14) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -##### websocketInterface? - -`WebSocketInterface` - -#### Returns - -`Attach` - -## Properties - -### handler - -> **handler**: `WebSocketInterface` - -Defined in: [src/attach.ts:10](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/attach.ts#L10) - -## Methods - -### attach() - -> **attach**(`namespace`, `podName`, `containerName`, `stdout`, `stderr`, `stdin`, `tty`): `Promise`\<`WebSocket`\> - -Defined in: [src/attach.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/attach.ts#L18) - -#### Parameters - -##### namespace - -`string` - -##### podName - -`string` - -##### containerName - -`string` - -##### stdout - -`any` - -##### stderr - -`any` - -##### stdin - -`any` - -##### tty - -`boolean` - -#### Returns - -`Promise`\<`WebSocket`\> diff --git a/website/docs/sdk/attach/index.md b/website/docs/sdk/attach/index.md deleted file mode 100644 index 5c8b2eedd03..00000000000 --- a/website/docs/sdk/attach/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# attach - -## Classes - -- [Attach](classes/Attach.md) diff --git a/website/docs/sdk/cache/classes/ListWatch.md b/website/docs/sdk/cache/classes/ListWatch.md deleted file mode 100644 index 63da18f3757..00000000000 --- a/website/docs/sdk/cache/classes/ListWatch.md +++ /dev/null @@ -1,248 +0,0 @@ -# Class: ListWatch\ - -Defined in: [src/cache.ts:26](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L26) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Implements - -- [`ObjectCache`](../interfaces/ObjectCache.md)\<`T`\> -- [`Informer`](../../informer/interfaces/Informer.md)\<`T`\> - -## Constructors - -### Constructor - -> **new ListWatch**\<`T`\>(`path`, `watch`, `listFn`, `autoStart?`, `labelSelector?`, `fieldSelector?`): `ListWatch`\<`T`\> - -Defined in: [src/cache.ts:39](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L39) - -#### Parameters - -##### path - -`string` - -##### watch - -[`Watch`](../../watch/classes/Watch.md) - -##### listFn - -[`ListPromise`](../../informer/type-aliases/ListPromise.md)\<`T`\> - -##### autoStart? - -`boolean` = `true` - -##### labelSelector? - -`string` - -##### fieldSelector? - -`string` - -#### Returns - -`ListWatch`\<`T`\> - -## Methods - -### get() - -> **get**(`name`, `namespace?`): `T` \| `undefined` - -Defined in: [src/cache.ts:113](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L113) - -#### Parameters - -##### name - -`string` - -##### namespace? - -`string` - -#### Returns - -`T` \| `undefined` - -#### Implementation of - -[`ObjectCache`](../interfaces/ObjectCache.md).[`get`](../interfaces/ObjectCache.md#get) - -*** - -### latestResourceVersion() - -> **latestResourceVersion**(): `string` - -Defined in: [src/cache.ts:136](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L136) - -#### Returns - -`string` - -*** - -### list() - -> **list**(`namespace?`): readonly `T`[] - -Defined in: [src/cache.ts:121](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L121) - -#### Parameters - -##### namespace? - -`string` - -#### Returns - -readonly `T`[] - -#### Implementation of - -[`ObjectCache`](../interfaces/ObjectCache.md).[`list`](../interfaces/ObjectCache.md#list) - -*** - -### off() - -#### Call Signature - -> **off**(`verb`, `cb`): `void` - -Defined in: [src/cache.ts:92](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L92) - -##### Parameters - -###### verb - -`"add"` \| `"update"` \| `"change"` \| `"delete"` - -###### cb - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\> - -##### Returns - -`void` - -##### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`off`](../../informer/interfaces/Informer.md#off) - -#### Call Signature - -> **off**(`verb`, `cb`): `void` - -Defined in: [src/cache.ts:93](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L93) - -##### Parameters - -###### verb - -`"connect"` \| `"error"` - -###### cb - -[`ErrorCallback`](../../informer/type-aliases/ErrorCallback.md) - -##### Returns - -`void` - -##### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`off`](../../informer/interfaces/Informer.md#off) - -*** - -### on() - -#### Call Signature - -> **on**(`verb`, `cb`): `void` - -Defined in: [src/cache.ts:74](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L74) - -##### Parameters - -###### verb - -`"add"` \| `"update"` \| `"change"` \| `"delete"` - -###### cb - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\> - -##### Returns - -`void` - -##### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`on`](../../informer/interfaces/Informer.md#on) - -#### Call Signature - -> **on**(`verb`, `cb`): `void` - -Defined in: [src/cache.ts:75](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L75) - -##### Parameters - -###### verb - -`"connect"` \| `"error"` - -###### cb - -[`ErrorCallback`](../../informer/type-aliases/ErrorCallback.md) - -##### Returns - -`void` - -##### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`on`](../../informer/interfaces/Informer.md#on) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [src/cache.ts:64](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L64) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`start`](../../informer/interfaces/Informer.md#start) - -*** - -### stop() - -> **stop**(): `Promise`\<`void`\> - -Defined in: [src/cache.ts:69](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L69) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`stop`](../../informer/interfaces/Informer.md#stop) diff --git a/website/docs/sdk/cache/functions/addOrUpdateObject.md b/website/docs/sdk/cache/functions/addOrUpdateObject.md deleted file mode 100644 index 51abb80b33d..00000000000 --- a/website/docs/sdk/cache/functions/addOrUpdateObject.md +++ /dev/null @@ -1,33 +0,0 @@ -# Function: addOrUpdateObject() - -> **addOrUpdateObject**\<`T`\>(`objects`, `obj`, `addCallbacks?`, `updateCallbacks?`): `void` - -Defined in: [src/cache.ts:296](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L296) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### objects - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -### obj - -`T` - -### addCallbacks? - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] - -### updateCallbacks? - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] - -## Returns - -`void` diff --git a/website/docs/sdk/cache/functions/cacheMapFromList.md b/website/docs/sdk/cache/functions/cacheMapFromList.md deleted file mode 100644 index eafe57a5fc2..00000000000 --- a/website/docs/sdk/cache/functions/cacheMapFromList.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: cacheMapFromList() - -> **cacheMapFromList**\<`T`\>(`newObjects`): [`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -Defined in: [src/cache.ts:244](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L244) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### newObjects - -`T`[] - -## Returns - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> diff --git a/website/docs/sdk/cache/functions/deleteItems.md b/website/docs/sdk/cache/functions/deleteItems.md deleted file mode 100644 index 7b9ea627c57..00000000000 --- a/website/docs/sdk/cache/functions/deleteItems.md +++ /dev/null @@ -1,29 +0,0 @@ -# Function: deleteItems() - -> **deleteItems**\<`T`\>(`oldObjects`, `newObjects`, `deleteCallback?`): [`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -Defined in: [src/cache.ts:264](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L264) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### oldObjects - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -### newObjects - -`T`[] - -### deleteCallback? - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] - -## Returns - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> diff --git a/website/docs/sdk/cache/functions/deleteObject.md b/website/docs/sdk/cache/functions/deleteObject.md deleted file mode 100644 index 16e5302f4f7..00000000000 --- a/website/docs/sdk/cache/functions/deleteObject.md +++ /dev/null @@ -1,29 +0,0 @@ -# Function: deleteObject() - -> **deleteObject**\<`T`\>(`objects`, `obj`, `deleteCallbacks?`): `void` - -Defined in: [src/cache.ts:334](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L334) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### objects - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -### obj - -`T` - -### deleteCallbacks? - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] - -## Returns - -`void` diff --git a/website/docs/sdk/cache/index.md b/website/docs/sdk/cache/index.md deleted file mode 100644 index 0ad962b28b3..00000000000 --- a/website/docs/sdk/cache/index.md +++ /dev/null @@ -1,20 +0,0 @@ -# cache - -## Classes - -- [ListWatch](classes/ListWatch.md) - -## Interfaces - -- [ObjectCache](interfaces/ObjectCache.md) - -## Type Aliases - -- [CacheMap](type-aliases/CacheMap.md) - -## Functions - -- [addOrUpdateObject](functions/addOrUpdateObject.md) -- [cacheMapFromList](functions/cacheMapFromList.md) -- [deleteItems](functions/deleteItems.md) -- [deleteObject](functions/deleteObject.md) diff --git a/website/docs/sdk/cache/interfaces/ObjectCache.md b/website/docs/sdk/cache/interfaces/ObjectCache.md deleted file mode 100644 index 7254f9c75a4..00000000000 --- a/website/docs/sdk/cache/interfaces/ObjectCache.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: ObjectCache\ - -Defined in: [src/cache.ts:17](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L17) - -## Type Parameters - -### T - -`T` - -## Methods - -### get() - -> **get**(`name`, `namespace?`): `T` \| `undefined` - -Defined in: [src/cache.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L18) - -#### Parameters - -##### name - -`string` - -##### namespace? - -`string` - -#### Returns - -`T` \| `undefined` - -*** - -### list() - -> **list**(`namespace?`): readonly `T`[] - -Defined in: [src/cache.ts:20](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L20) - -#### Parameters - -##### namespace? - -`string` - -#### Returns - -readonly `T`[] diff --git a/website/docs/sdk/cache/type-aliases/CacheMap.md b/website/docs/sdk/cache/type-aliases/CacheMap.md deleted file mode 100644 index 15cd2002ae6..00000000000 --- a/website/docs/sdk/cache/type-aliases/CacheMap.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: CacheMap\ - -> **CacheMap**\<`T`\> = `Map`\<`string`, `Map`\<`string`, `T`\>\> - -Defined in: [src/cache.ts:24](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cache.ts#L24) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) diff --git a/website/docs/sdk/config/classes/KubeConfig.md b/website/docs/sdk/config/classes/KubeConfig.md deleted file mode 100644 index 9ad78d210da..00000000000 --- a/website/docs/sdk/config/classes/KubeConfig.md +++ /dev/null @@ -1,559 +0,0 @@ -# Class: KubeConfig - -Defined in: [src/config.ts:68](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L68) - -## Implements - -- `SecurityAuthentication` - -## Constructors - -### Constructor - -> **new KubeConfig**(): `KubeConfig` - -Defined in: [src/config.ts:106](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L106) - -#### Returns - -`KubeConfig` - -## Properties - -### clusters - -> **clusters**: [`Cluster`](../../config_types/interfaces/Cluster.md)[] - -Defined in: [src/config.ts:89](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L89) - -The list of all known clusters - -*** - -### contexts - -> **contexts**: [`Context`](../../config_types/interfaces/Context.md)[] - -Defined in: [src/config.ts:99](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L99) - -The list of all known contexts - -*** - -### currentContext - -> **currentContext**: `string` - -Defined in: [src/config.ts:104](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L104) - -The name of the current context - -*** - -### users - -> **users**: [`User`](../../config_types/interfaces/User.md)[] - -Defined in: [src/config.ts:94](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L94) - -The list of all known users - -## Methods - -### addAuthenticator() - -> **addAuthenticator**(`authenticator`): `void` - -Defined in: [src/config.ts:82](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L82) - -#### Parameters - -##### authenticator - -`Authenticator` - -#### Returns - -`void` - -*** - -### addCluster() - -> **addCluster**(`cluster`): `void` - -Defined in: [src/config.ts:385](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L385) - -#### Parameters - -##### cluster - -[`Cluster`](../../config_types/interfaces/Cluster.md) - -#### Returns - -`void` - -*** - -### addContext() - -> **addContext**(`ctx`): `void` - -Defined in: [src/config.ts:409](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L409) - -#### Parameters - -##### ctx - -[`Context`](../../config_types/interfaces/Context.md) - -#### Returns - -`void` - -*** - -### addUser() - -> **addUser**(`user`): `void` - -Defined in: [src/config.ts:397](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L397) - -#### Parameters - -##### user - -[`User`](../../config_types/interfaces/User.md) - -#### Returns - -`void` - -*** - -### applySecurityAuthentication() - -> **applySecurityAuthentication**(`context`): `Promise`\<`void`\> - -Defined in: [src/config.ts:239](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L239) - -Applies SecurityAuthentication to RequestContext of an API Call from API Client - -#### Parameters - -##### context - -`RequestContext` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -`SecurityAuthentication.applySecurityAuthentication` - -*** - -### applyToFetchOptions() - -> **applyToFetchOptions**(`opts`): `Promise`\<`RequestInit`\> - -Defined in: [src/config.ts:169](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L169) - -#### Parameters - -##### opts - -`RequestOptions` - -#### Returns - -`Promise`\<`RequestInit`\> - -*** - -### applyToHTTPSOptions() - -> **applyToHTTPSOptions**(`opts`): `Promise`\<`void`\> - -Defined in: [src/config.ts:192](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L192) - -#### Parameters - -##### opts - -`any` - -#### Returns - -`Promise`\<`void`\> - -*** - -### exportConfig() - -> **exportConfig**(): `string` - -Defined in: [src/config.ts:526](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L526) - -#### Returns - -`string` - -*** - -### getCluster() - -> **getCluster**(`name`): [`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` - -Defined in: [src/config.ts:147](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L147) - -#### Parameters - -##### name - -`string` - -#### Returns - -[`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` - -*** - -### getClusters() - -> **getClusters**(): [`Cluster`](../../config_types/interfaces/Cluster.md)[] - -Defined in: [src/config.ts:116](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L116) - -#### Returns - -[`Cluster`](../../config_types/interfaces/Cluster.md)[] - -*** - -### getContextObject() - -> **getContextObject**(`name`): [`Context`](../../config_types/interfaces/Context.md) \| `null` - -Defined in: [src/config.ts:132](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L132) - -#### Parameters - -##### name - -`string` - -#### Returns - -[`Context`](../../config_types/interfaces/Context.md) \| `null` - -*** - -### getContexts() - -> **getContexts**(): [`Context`](../../config_types/interfaces/Context.md)[] - -Defined in: [src/config.ts:112](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L112) - -#### Returns - -[`Context`](../../config_types/interfaces/Context.md)[] - -*** - -### getCurrentCluster() - -> **getCurrentCluster**(): [`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` - -Defined in: [src/config.ts:139](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L139) - -#### Returns - -[`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` - -*** - -### getCurrentContext() - -> **getCurrentContext**(): `string` - -Defined in: [src/config.ts:124](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L124) - -#### Returns - -`string` - -*** - -### getCurrentUser() - -> **getCurrentUser**(): [`User`](../../config_types/interfaces/User.md) \| `null` - -Defined in: [src/config.ts:151](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L151) - -#### Returns - -[`User`](../../config_types/interfaces/User.md) \| `null` - -*** - -### getName() - -> **getName**(): `string` - -Defined in: [src/config.ts:285](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L285) - -Returns name of this security authentication method - -#### Returns - -`string` - -string - -#### Implementation of - -`SecurityAuthentication.getName` - -*** - -### getUser() - -> **getUser**(`name`): [`User`](../../config_types/interfaces/User.md) \| `null` - -Defined in: [src/config.ts:159](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L159) - -#### Parameters - -##### name - -`string` - -#### Returns - -[`User`](../../config_types/interfaces/User.md) \| `null` - -*** - -### getUsers() - -> **getUsers**(): [`User`](../../config_types/interfaces/User.md)[] - -Defined in: [src/config.ts:120](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L120) - -#### Returns - -[`User`](../../config_types/interfaces/User.md)[] - -*** - -### loadFromCluster() - -> **loadFromCluster**(`pathPrefix?`): `void` - -Defined in: [src/config.ts:317](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L317) - -#### Parameters - -##### pathPrefix? - -`string` = `''` - -#### Returns - -`void` - -*** - -### loadFromClusterAndUser() - -> **loadFromClusterAndUser**(`cluster`, `user`): `void` - -Defined in: [src/config.ts:304](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L304) - -#### Parameters - -##### cluster - -[`Cluster`](../../config_types/interfaces/Cluster.md) - -##### user - -[`User`](../../config_types/interfaces/User.md) - -#### Returns - -`void` - -*** - -### loadFromDefault() - -> **loadFromDefault**(`opts?`, `contextFromStartingConfig?`, `platform?`): `void` - -Defined in: [src/config.ts:421](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L421) - -#### Parameters - -##### opts? - -`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> - -##### contextFromStartingConfig? - -`boolean` = `false` - -##### platform? - -`string` = `process.platform` - -#### Returns - -`void` - -*** - -### loadFromFile() - -> **loadFromFile**(`file`, `opts?`): `void` - -Defined in: [src/config.ts:163](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L163) - -#### Parameters - -##### file - -`string` - -##### opts? - -`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> - -#### Returns - -`void` - -*** - -### loadFromOptions() - -> **loadFromOptions**(`options`): `void` - -Defined in: [src/config.ts:297](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L297) - -#### Parameters - -##### options - -`any` - -#### Returns - -`void` - -*** - -### loadFromString() - -> **loadFromString**(`config`, `opts?`): `void` - -Defined in: [src/config.ts:289](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L289) - -#### Parameters - -##### config - -`string` - -##### opts? - -`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> - -#### Returns - -`void` - -*** - -### makeApiClient() - -> **makeApiClient**\<`T`\>(`apiClientType`): `T` - -Defined in: [src/config.ts:490](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L490) - -#### Type Parameters - -##### T - -`T` *extends* [`ApiType`](../interfaces/ApiType.md) - -#### Parameters - -##### apiClientType - -[`ApiConstructor`](../type-aliases/ApiConstructor.md)\<`T`\> - -#### Returns - -`T` - -*** - -### makePathsAbsolute() - -> **makePathsAbsolute**(`rootDirectory`): `void` - -Defined in: [src/config.ts:510](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L510) - -#### Parameters - -##### rootDirectory - -`string` - -#### Returns - -`void` - -*** - -### mergeConfig() - -> **mergeConfig**(`config`, `preserveContext?`): `void` - -Defined in: [src/config.ts:370](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L370) - -#### Parameters - -##### config - -`KubeConfig` - -##### preserveContext? - -`boolean` = `false` - -#### Returns - -`void` - -*** - -### setCurrentContext() - -> **setCurrentContext**(`context`): `void` - -Defined in: [src/config.ts:128](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L128) - -#### Parameters - -##### context - -`string` - -#### Returns - -`void` diff --git a/website/docs/sdk/config/functions/bufferFromFileOrString.md b/website/docs/sdk/config/functions/bufferFromFileOrString.md deleted file mode 100644 index abf155bebf4..00000000000 --- a/website/docs/sdk/config/functions/bufferFromFileOrString.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: bufferFromFileOrString() - -> **bufferFromFileOrString**(`file?`, `data?`): `Buffer` \| `null` - -Defined in: [src/config.ts:652](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L652) - -## Parameters - -### file? - -`string` - -### data? - -`string` - -## Returns - -`Buffer` \| `null` diff --git a/website/docs/sdk/config/functions/findHomeDir.md b/website/docs/sdk/config/functions/findHomeDir.md deleted file mode 100644 index dcd6aeaee2a..00000000000 --- a/website/docs/sdk/config/functions/findHomeDir.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: findHomeDir() - -> **findHomeDir**(`platform?`): `string` \| `null` - -Defined in: [src/config.ts:675](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L675) - -## Parameters - -### platform? - -`string` = `process.platform` - -## Returns - -`string` \| `null` diff --git a/website/docs/sdk/config/functions/findObject.md b/website/docs/sdk/config/functions/findObject.md deleted file mode 100644 index 9cad51430a0..00000000000 --- a/website/docs/sdk/config/functions/findObject.md +++ /dev/null @@ -1,29 +0,0 @@ -# Function: findObject() - -> **findObject**\<`T`\>(`list`, `name`, `key`): `T` \| `null` - -Defined in: [src/config.ts:734](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L734) - -## Type Parameters - -### T - -`T` *extends* [`Named`](../interfaces/Named.md) - -## Parameters - -### list - -`T`[] - -### name - -`string` - -### key - -`string` - -## Returns - -`T` \| `null` diff --git a/website/docs/sdk/config/functions/makeAbsolutePath.md b/website/docs/sdk/config/functions/makeAbsolutePath.md deleted file mode 100644 index ca184049b6b..00000000000 --- a/website/docs/sdk/config/functions/makeAbsolutePath.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: makeAbsolutePath() - -> **makeAbsolutePath**(`root`, `file`): `string` - -Defined in: [src/config.ts:644](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L644) - -## Parameters - -### root - -`string` - -### file - -`string` - -## Returns - -`string` diff --git a/website/docs/sdk/config/index.md b/website/docs/sdk/config/index.md deleted file mode 100644 index 9b7c0e788d9..00000000000 --- a/website/docs/sdk/config/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# config - -## Classes - -- [KubeConfig](classes/KubeConfig.md) - -## Interfaces - -- [ApiType](interfaces/ApiType.md) -- [Named](interfaces/Named.md) - -## Type Aliases - -- [ApiConstructor](type-aliases/ApiConstructor.md) - -## Functions - -- [bufferFromFileOrString](functions/bufferFromFileOrString.md) -- [findHomeDir](functions/findHomeDir.md) -- [findObject](functions/findObject.md) -- [makeAbsolutePath](functions/makeAbsolutePath.md) diff --git a/website/docs/sdk/config/interfaces/ApiType.md b/website/docs/sdk/config/interfaces/ApiType.md deleted file mode 100644 index 5406d3b4c89..00000000000 --- a/website/docs/sdk/config/interfaces/ApiType.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: ApiType - -Defined in: [src/config.ts:66](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L66) diff --git a/website/docs/sdk/config/interfaces/Named.md b/website/docs/sdk/config/interfaces/Named.md deleted file mode 100644 index f1480568686..00000000000 --- a/website/docs/sdk/config/interfaces/Named.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: Named - -Defined in: [src/config.ts:729](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L729) - -## Properties - -### name - -> **name**: `string` - -Defined in: [src/config.ts:730](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L730) diff --git a/website/docs/sdk/config/type-aliases/ApiConstructor.md b/website/docs/sdk/config/type-aliases/ApiConstructor.md deleted file mode 100644 index 22b5638b276..00000000000 --- a/website/docs/sdk/config/type-aliases/ApiConstructor.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ApiConstructor\ - -> **ApiConstructor**\<`T`\> = (`config`) => `T` - -Defined in: [src/config.ts:642](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config.ts#L642) - -## Type Parameters - -### T - -`T` *extends* [`ApiType`](../interfaces/ApiType.md) - -## Parameters - -### config - -`Configuration` - -## Returns - -`T` diff --git a/website/docs/sdk/config_types/functions/exportCluster.md b/website/docs/sdk/config_types/functions/exportCluster.md deleted file mode 100644 index 2ef992801b6..00000000000 --- a/website/docs/sdk/config_types/functions/exportCluster.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: exportCluster() - -> **exportCluster**(`cluster`): `any` - -Defined in: [src/config\_types.ts:40](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L40) - -## Parameters - -### cluster - -[`Cluster`](../interfaces/Cluster.md) - -## Returns - -`any` diff --git a/website/docs/sdk/config_types/functions/exportContext.md b/website/docs/sdk/config_types/functions/exportContext.md deleted file mode 100644 index db3175d764c..00000000000 --- a/website/docs/sdk/config_types/functions/exportContext.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: exportContext() - -> **exportContext**(`ctx`): `any` - -Defined in: [src/config\_types.ts:190](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L190) - -## Parameters - -### ctx - -[`Context`](../interfaces/Context.md) - -## Returns - -`any` diff --git a/website/docs/sdk/config_types/functions/exportUser.md b/website/docs/sdk/config_types/functions/exportUser.md deleted file mode 100644 index 90ad74dbdf1..00000000000 --- a/website/docs/sdk/config_types/functions/exportUser.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: exportUser() - -> **exportUser**(`user`): `any` - -Defined in: [src/config\_types.ts:113](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L113) - -## Parameters - -### user - -[`User`](../interfaces/User.md) - -## Returns - -`any` diff --git a/website/docs/sdk/config_types/functions/newClusters.md b/website/docs/sdk/config_types/functions/newClusters.md deleted file mode 100644 index a5c7b658ca8..00000000000 --- a/website/docs/sdk/config_types/functions/newClusters.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: newClusters() - -> **newClusters**(`a`, `opts?`): [`Cluster`](../interfaces/Cluster.md)[] - -Defined in: [src/config\_types.ts:30](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L30) - -## Parameters - -### a - -`any` - -### opts? - -`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> - -## Returns - -[`Cluster`](../interfaces/Cluster.md)[] diff --git a/website/docs/sdk/config_types/functions/newContexts.md b/website/docs/sdk/config_types/functions/newContexts.md deleted file mode 100644 index c3afceea381..00000000000 --- a/website/docs/sdk/config_types/functions/newContexts.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: newContexts() - -> **newContexts**(`a`, `opts?`): [`Context`](../interfaces/Context.md)[] - -Defined in: [src/config\_types.ts:180](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L180) - -## Parameters - -### a - -`any` - -### opts? - -`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> - -## Returns - -[`Context`](../interfaces/Context.md)[] diff --git a/website/docs/sdk/config_types/functions/newUsers.md b/website/docs/sdk/config_types/functions/newUsers.md deleted file mode 100644 index d6fba827803..00000000000 --- a/website/docs/sdk/config_types/functions/newUsers.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: newUsers() - -> **newUsers**(`a`, `opts?`): [`User`](../interfaces/User.md)[] - -Defined in: [src/config\_types.ts:103](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L103) - -## Parameters - -### a - -`any` - -### opts? - -`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> - -## Returns - -[`User`](../interfaces/User.md)[] diff --git a/website/docs/sdk/config_types/index.md b/website/docs/sdk/config_types/index.md deleted file mode 100644 index 35ebc25425d..00000000000 --- a/website/docs/sdk/config_types/index.md +++ /dev/null @@ -1,25 +0,0 @@ -# config\_types - -## Interfaces - -- [Cluster](interfaces/Cluster.md) -- [ConfigOptions](interfaces/ConfigOptions.md) -- [Context](interfaces/Context.md) -- [User](interfaces/User.md) - -## Type Aliases - -- [ActionOnInvalid](type-aliases/ActionOnInvalid.md) - -## Variables - -- [ActionOnInvalid](variables/ActionOnInvalid.md) - -## Functions - -- [exportCluster](functions/exportCluster.md) -- [exportContext](functions/exportContext.md) -- [exportUser](functions/exportUser.md) -- [newClusters](functions/newClusters.md) -- [newContexts](functions/newContexts.md) -- [newUsers](functions/newUsers.md) diff --git a/website/docs/sdk/config_types/interfaces/Cluster.md b/website/docs/sdk/config_types/interfaces/Cluster.md deleted file mode 100644 index 5b2d7cb273d..00000000000 --- a/website/docs/sdk/config_types/interfaces/Cluster.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: Cluster - -Defined in: [src/config\_types.ts:20](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L20) - -## Properties - -### caData? - -> `readonly` `optional` **caData?**: `string` - -Defined in: [src/config\_types.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L22) - -*** - -### caFile? - -> `optional` **caFile?**: `string` - -Defined in: [src/config\_types.ts:23](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L23) - -*** - -### name - -> `readonly` **name**: `string` - -Defined in: [src/config\_types.ts:21](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L21) - -*** - -### proxyUrl? - -> `readonly` `optional` **proxyUrl?**: `string` - -Defined in: [src/config\_types.ts:27](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L27) - -*** - -### server - -> `readonly` **server**: `string` - -Defined in: [src/config\_types.ts:24](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L24) - -*** - -### skipTLSVerify - -> `readonly` **skipTLSVerify**: `boolean` - -Defined in: [src/config\_types.ts:26](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L26) - -*** - -### tlsServerName? - -> `readonly` `optional` **tlsServerName?**: `string` - -Defined in: [src/config\_types.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L25) diff --git a/website/docs/sdk/config_types/interfaces/ConfigOptions.md b/website/docs/sdk/config_types/interfaces/ConfigOptions.md deleted file mode 100644 index 990ee91e7bb..00000000000 --- a/website/docs/sdk/config_types/interfaces/ConfigOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: ConfigOptions - -Defined in: [src/config\_types.ts:10](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L10) - -## Properties - -### onInvalidEntry - -> **onInvalidEntry**: [`ActionOnInvalid`](../type-aliases/ActionOnInvalid.md) - -Defined in: [src/config\_types.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L11) diff --git a/website/docs/sdk/config_types/interfaces/Context.md b/website/docs/sdk/config_types/interfaces/Context.md deleted file mode 100644 index ee680eacb66..00000000000 --- a/website/docs/sdk/config_types/interfaces/Context.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: Context - -Defined in: [src/config\_types.ts:173](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L173) - -## Properties - -### cluster - -> `readonly` **cluster**: `string` - -Defined in: [src/config\_types.ts:174](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L174) - -*** - -### name - -> `readonly` **name**: `string` - -Defined in: [src/config\_types.ts:176](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L176) - -*** - -### namespace? - -> `readonly` `optional` **namespace?**: `string` - -Defined in: [src/config\_types.ts:177](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L177) - -*** - -### user - -> `readonly` **user**: `string` - -Defined in: [src/config\_types.ts:175](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L175) diff --git a/website/docs/sdk/config_types/interfaces/User.md b/website/docs/sdk/config_types/interfaces/User.md deleted file mode 100644 index e2378af16a4..00000000000 --- a/website/docs/sdk/config_types/interfaces/User.md +++ /dev/null @@ -1,91 +0,0 @@ -# Interface: User - -Defined in: [src/config\_types.ts:89](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L89) - -## Properties - -### authProvider? - -> `readonly` `optional` **authProvider?**: `any` - -Defined in: [src/config\_types.ts:96](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L96) - -*** - -### certData? - -> `readonly` `optional` **certData?**: `string` - -Defined in: [src/config\_types.ts:91](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L91) - -*** - -### certFile? - -> `optional` **certFile?**: `string` - -Defined in: [src/config\_types.ts:92](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L92) - -*** - -### exec? - -> `readonly` `optional` **exec?**: `any` - -Defined in: [src/config\_types.ts:93](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L93) - -*** - -### impersonateUser? - -> `readonly` `optional` **impersonateUser?**: `string` - -Defined in: [src/config\_types.ts:100](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L100) - -*** - -### keyData? - -> `readonly` `optional` **keyData?**: `string` - -Defined in: [src/config\_types.ts:94](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L94) - -*** - -### keyFile? - -> `optional` **keyFile?**: `string` - -Defined in: [src/config\_types.ts:95](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L95) - -*** - -### name - -> `readonly` **name**: `string` - -Defined in: [src/config\_types.ts:90](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L90) - -*** - -### password? - -> `readonly` `optional` **password?**: `string` - -Defined in: [src/config\_types.ts:99](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L99) - -*** - -### token? - -> `readonly` `optional` **token?**: `string` - -Defined in: [src/config\_types.ts:97](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L97) - -*** - -### username? - -> `readonly` `optional` **username?**: `string` - -Defined in: [src/config\_types.ts:98](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L98) diff --git a/website/docs/sdk/config_types/type-aliases/ActionOnInvalid.md b/website/docs/sdk/config_types/type-aliases/ActionOnInvalid.md deleted file mode 100644 index 5efbfe045a9..00000000000 --- a/website/docs/sdk/config_types/type-aliases/ActionOnInvalid.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ActionOnInvalid - -> **ActionOnInvalid** = *typeof* [`ActionOnInvalid`](../variables/ActionOnInvalid.md)\[keyof *typeof* [`ActionOnInvalid`](../variables/ActionOnInvalid.md)\] - -Defined in: [src/config\_types.ts:3](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L3) diff --git a/website/docs/sdk/config_types/variables/ActionOnInvalid.md b/website/docs/sdk/config_types/variables/ActionOnInvalid.md deleted file mode 100644 index fc3653c8e3e..00000000000 --- a/website/docs/sdk/config_types/variables/ActionOnInvalid.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: ActionOnInvalid - -> `const` **ActionOnInvalid**: `object` - -Defined in: [src/config\_types.ts:3](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/config_types.ts#L3) - -## Type Declaration - -### FILTER - -> `readonly` **FILTER**: `"filter"` = `'filter'` - -### THROW - -> `readonly` **THROW**: `"throw"` = `'throw'` diff --git a/website/docs/sdk/cp/classes/Cp.md b/website/docs/sdk/cp/classes/Cp.md deleted file mode 100644 index 8caf135c89e..00000000000 --- a/website/docs/sdk/cp/classes/Cp.md +++ /dev/null @@ -1,127 +0,0 @@ -# Class: Cp - -Defined in: [src/cp.ts:7](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L7) - -## Constructors - -### Constructor - -> **new Cp**(`config`, `execInstance?`): `Cp` - -Defined in: [src/cp.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L9) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -##### execInstance? - -[`Exec`](../../exec/classes/Exec.md) - -#### Returns - -`Cp` - -## Properties - -### execInstance - -> **execInstance**: [`Exec`](../../exec/classes/Exec.md) - -Defined in: [src/cp.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L8) - -## Methods - -### cpFromPod() - -> **cpFromPod**(`namespace`, `podName`, `containerName`, `srcPath`, `tgtPath`, `cwd?`): `Promise`\<`void`\> - -Defined in: [src/cp.ts:21](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L21) - -#### Parameters - -##### namespace - -`string` - -The namespace of the pod to exec the command inside. - -##### podName - -`string` - -The name of the pod to exec the command inside. - -##### containerName - -`string` - -The name of the container in the pod to exec the command inside. - -##### srcPath - -`string` - -The source path in the pod - -##### tgtPath - -`string` - -The target path in local - -##### cwd? - -`string` - -The directory that is used as the parent in the pod when downloading - -#### Returns - -`Promise`\<`void`\> - -*** - -### cpToPod() - -> **cpToPod**(`namespace`, `podName`, `containerName`, `srcPath`, `tgtPath`): `Promise`\<`void`\> - -Defined in: [src/cp.ts:60](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/cp.ts#L60) - -#### Parameters - -##### namespace - -`string` - -The namespace of the pod to exec the command inside. - -##### podName - -`string` - -The name of the pod to exec the command inside. - -##### containerName - -`string` - -The name of the container in the pod to exec the command inside. - -##### srcPath - -`string` - -The source path in local - -##### tgtPath - -`string` - -The target path in the pod - -#### Returns - -`Promise`\<`void`\> diff --git a/website/docs/sdk/cp/index.md b/website/docs/sdk/cp/index.md deleted file mode 100644 index 67baee4077a..00000000000 --- a/website/docs/sdk/cp/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# cp - -## Classes - -- [Cp](classes/Cp.md) diff --git a/website/docs/sdk/exec/classes/Exec.md b/website/docs/sdk/exec/classes/Exec.md deleted file mode 100644 index 297c7d4b1fc..00000000000 --- a/website/docs/sdk/exec/classes/Exec.md +++ /dev/null @@ -1,103 +0,0 @@ -# Class: Exec - -Defined in: [src/exec.ts:10](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/exec.ts#L10) - -## Constructors - -### Constructor - -> **new Exec**(`config`, `wsInterface?`): `Exec` - -Defined in: [src/exec.ts:15](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/exec.ts#L15) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -##### wsInterface? - -`WebSocketInterface` - -#### Returns - -`Exec` - -## Properties - -### handler - -> **handler**: `WebSocketInterface` - -Defined in: [src/exec.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/exec.ts#L11) - -## Methods - -### exec() - -> **exec**(`namespace`, `podName`, `containerName`, `command`, `stdout`, `stderr`, `stdin`, `tty`, `statusCallback?`): `Promise`\<`WebSocket`\> - -Defined in: [src/exec.ts:32](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/exec.ts#L32) - -#### Parameters - -##### namespace - -`string` - -The namespace of the pod to exec the command inside. - -##### podName - -`string` - -The name of the pod to exec the command inside. - -##### containerName - -`string` - -The name of the container in the pod to exec the command inside. - -##### command - -`string` \| `string`[] - -The command or command and arguments to execute. - -##### stdout - -`Writable` \| `null` - -The stream to write stdout data from the command. - -##### stderr - -`Writable` \| `null` - -The stream to write stderr data from the command. - -##### stdin - -`Readable` \| `null` - -The stream to write stdin data into the command. - -##### tty - -`boolean` - -Should the command execute in a TTY enabled session. - -##### statusCallback? - -(`status`) => `void` - -A callback to received the status (e.g. exit code) from the command, optional. - -#### Returns - -`Promise`\<`WebSocket`\> - -A promise that will return the web socket created for this command. diff --git a/website/docs/sdk/exec/index.md b/website/docs/sdk/exec/index.md deleted file mode 100644 index 84d31a7aad2..00000000000 --- a/website/docs/sdk/exec/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# exec - -## Classes - -- [Exec](classes/Exec.md) diff --git a/website/docs/sdk/health/classes/Health.md b/website/docs/sdk/health/classes/Health.md deleted file mode 100644 index 4c6e8144d03..00000000000 --- a/website/docs/sdk/health/classes/Health.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: Health - -Defined in: [src/health.ts:5](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L5) - -## Constructors - -### Constructor - -> **new Health**(`config`): `Health` - -Defined in: [src/health.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L8) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -#### Returns - -`Health` - -## Properties - -### config - -> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) - -Defined in: [src/health.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L6) - -## Methods - -### livez() - -> **livez**(`opts`): `Promise`\<`boolean`\> - -Defined in: [src/health.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L16) - -#### Parameters - -##### opts - -`RequestOptions` - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### readyz() - -> **readyz**(`opts`): `Promise`\<`boolean`\> - -Defined in: [src/health.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/health.ts#L12) - -#### Parameters - -##### opts - -`RequestOptions` - -#### Returns - -`Promise`\<`boolean`\> diff --git a/website/docs/sdk/health/index.md b/website/docs/sdk/health/index.md deleted file mode 100644 index ee17d9e0f20..00000000000 --- a/website/docs/sdk/health/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# health - -## Classes - -- [Health](classes/Health.md) diff --git a/website/docs/sdk/index.md b/website/docs/sdk/index.md deleted file mode 100644 index 206b899986f..00000000000 --- a/website/docs/sdk/index.md +++ /dev/null @@ -1,22 +0,0 @@ -# @kubernetes/client-node - -## Modules - -- [attach](attach/index.md) -- [cache](cache/index.md) -- [config](config/index.md) -- [config\_types](config_types/index.md) -- [cp](cp/index.md) -- [exec](exec/index.md) -- [health](health/index.md) -- [informer](informer/index.md) -- [log](log/index.md) -- [metrics](metrics/index.md) -- [middleware](middleware/index.md) -- [object](object/index.md) -- [patch](patch/index.md) -- [portforward](portforward/index.md) -- [top](top/index.md) -- [types](types/index.md) -- [watch](watch/index.md) -- [yaml](yaml/index.md) diff --git a/website/docs/sdk/informer/functions/makeInformer.md b/website/docs/sdk/informer/functions/makeInformer.md deleted file mode 100644 index 041b93c350b..00000000000 --- a/website/docs/sdk/informer/functions/makeInformer.md +++ /dev/null @@ -1,33 +0,0 @@ -# Function: makeInformer() - -> **makeInformer**\<`T`\>(`kubeconfig`, `path`, `listPromiseFn`, `labelSelector?`): [`Informer`](../interfaces/Informer.md)\<`T`\> & [`ObjectCache`](../../cache/interfaces/ObjectCache.md)\<`T`\> - -Defined in: [src/informer.ts:37](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L37) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### kubeconfig - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -### path - -`string` - -### listPromiseFn - -[`ListPromise`](../type-aliases/ListPromise.md)\<`T`\> - -### labelSelector? - -`string` - -## Returns - -[`Informer`](../interfaces/Informer.md)\<`T`\> & [`ObjectCache`](../../cache/interfaces/ObjectCache.md)\<`T`\> diff --git a/website/docs/sdk/informer/index.md b/website/docs/sdk/informer/index.md deleted file mode 100644 index b8b436f663a..00000000000 --- a/website/docs/sdk/informer/index.md +++ /dev/null @@ -1,31 +0,0 @@ -# informer - -## Interfaces - -- [Informer](interfaces/Informer.md) - -## Type Aliases - -- [ADD](type-aliases/ADD.md) -- [CHANGE](type-aliases/CHANGE.md) -- [CONNECT](type-aliases/CONNECT.md) -- [DELETE](type-aliases/DELETE.md) -- [ERROR](type-aliases/ERROR.md) -- [ErrorCallback](type-aliases/ErrorCallback.md) -- [ListCallback](type-aliases/ListCallback.md) -- [ListPromise](type-aliases/ListPromise.md) -- [ObjectCallback](type-aliases/ObjectCallback.md) -- [UPDATE](type-aliases/UPDATE.md) - -## Variables - -- [ADD](variables/ADD.md) -- [CHANGE](variables/CHANGE.md) -- [CONNECT](variables/CONNECT.md) -- [DELETE](variables/DELETE.md) -- [ERROR](variables/ERROR.md) -- [UPDATE](variables/UPDATE.md) - -## Functions - -- [makeInformer](functions/makeInformer.md) diff --git a/website/docs/sdk/informer/interfaces/Informer.md b/website/docs/sdk/informer/interfaces/Informer.md deleted file mode 100644 index 06470ae457b..00000000000 --- a/website/docs/sdk/informer/interfaces/Informer.md +++ /dev/null @@ -1,121 +0,0 @@ -# Interface: Informer\ - -Defined in: [src/informer.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L28) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Methods - -### off() - -#### Call Signature - -> **off**(`verb`, `cb`): `void` - -Defined in: [src/informer.ts:31](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L31) - -##### Parameters - -###### verb - -`"add"` \| `"update"` \| `"change"` \| `"delete"` - -###### cb - -[`ObjectCallback`](../type-aliases/ObjectCallback.md)\<`T`\> - -##### Returns - -`void` - -#### Call Signature - -> **off**(`verb`, `cb`): `void` - -Defined in: [src/informer.ts:32](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L32) - -##### Parameters - -###### verb - -`"connect"` \| `"error"` - -###### cb - -[`ErrorCallback`](../type-aliases/ErrorCallback.md) - -##### Returns - -`void` - -*** - -### on() - -#### Call Signature - -> **on**(`verb`, `cb`): `void` - -Defined in: [src/informer.ts:29](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L29) - -##### Parameters - -###### verb - -`"add"` \| `"update"` \| `"change"` \| `"delete"` - -###### cb - -[`ObjectCallback`](../type-aliases/ObjectCallback.md)\<`T`\> - -##### Returns - -`void` - -#### Call Signature - -> **on**(`verb`, `cb`): `void` - -Defined in: [src/informer.ts:30](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L30) - -##### Parameters - -###### verb - -`"connect"` \| `"error"` - -###### cb - -[`ErrorCallback`](../type-aliases/ErrorCallback.md) - -##### Returns - -`void` - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [src/informer.ts:33](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L33) - -#### Returns - -`Promise`\<`void`\> - -*** - -### stop() - -> **stop**(): `Promise`\<`void`\> - -Defined in: [src/informer.ts:34](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L34) - -#### Returns - -`Promise`\<`void`\> diff --git a/website/docs/sdk/informer/type-aliases/ADD.md b/website/docs/sdk/informer/type-aliases/ADD.md deleted file mode 100644 index 7194326e2b4..00000000000 --- a/website/docs/sdk/informer/type-aliases/ADD.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ADD - -> **ADD** = *typeof* [`ADD`](../variables/ADD.md) - -Defined in: [src/informer.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L12) diff --git a/website/docs/sdk/informer/type-aliases/CHANGE.md b/website/docs/sdk/informer/type-aliases/CHANGE.md deleted file mode 100644 index eba2b6d992f..00000000000 --- a/website/docs/sdk/informer/type-aliases/CHANGE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CHANGE - -> **CHANGE** = *typeof* [`CHANGE`](../variables/CHANGE.md) - -Defined in: [src/informer.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L16) diff --git a/website/docs/sdk/informer/type-aliases/CONNECT.md b/website/docs/sdk/informer/type-aliases/CONNECT.md deleted file mode 100644 index 23b4eeffa9d..00000000000 --- a/website/docs/sdk/informer/type-aliases/CONNECT.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CONNECT - -> **CONNECT** = *typeof* [`CONNECT`](../variables/CONNECT.md) - -Defined in: [src/informer.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L22) diff --git a/website/docs/sdk/informer/type-aliases/DELETE.md b/website/docs/sdk/informer/type-aliases/DELETE.md deleted file mode 100644 index 7bdd5eb6f36..00000000000 --- a/website/docs/sdk/informer/type-aliases/DELETE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: DELETE - -> **DELETE** = *typeof* [`DELETE`](../variables/DELETE.md) - -Defined in: [src/informer.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L18) diff --git a/website/docs/sdk/informer/type-aliases/ERROR.md b/website/docs/sdk/informer/type-aliases/ERROR.md deleted file mode 100644 index 7ce19f01d3b..00000000000 --- a/website/docs/sdk/informer/type-aliases/ERROR.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ERROR - -> **ERROR** = *typeof* [`ERROR`](../variables/ERROR.md) - -Defined in: [src/informer.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L25) diff --git a/website/docs/sdk/informer/type-aliases/ErrorCallback.md b/website/docs/sdk/informer/type-aliases/ErrorCallback.md deleted file mode 100644 index 689f8610d9e..00000000000 --- a/website/docs/sdk/informer/type-aliases/ErrorCallback.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ErrorCallback - -> **ErrorCallback** = (`err?`) => `void` - -Defined in: [src/informer.ts:7](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L7) - -## Parameters - -### err? - -`any` - -## Returns - -`void` diff --git a/website/docs/sdk/informer/type-aliases/ListCallback.md b/website/docs/sdk/informer/type-aliases/ListCallback.md deleted file mode 100644 index 561f3606c53..00000000000 --- a/website/docs/sdk/informer/type-aliases/ListCallback.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: ListCallback\ - -> **ListCallback**\<`T`\> = (`list`, `ResourceVersion`) => `void` - -Defined in: [src/informer.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L8) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### list - -`T`[] - -### ResourceVersion - -`string` - -## Returns - -`void` diff --git a/website/docs/sdk/informer/type-aliases/ListPromise.md b/website/docs/sdk/informer/type-aliases/ListPromise.md deleted file mode 100644 index c7ebc97c42e..00000000000 --- a/website/docs/sdk/informer/type-aliases/ListPromise.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ListPromise\ - -> **ListPromise**\<`T`\> = () => `Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> - -Defined in: [src/informer.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L9) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Returns - -`Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> diff --git a/website/docs/sdk/informer/type-aliases/ObjectCallback.md b/website/docs/sdk/informer/type-aliases/ObjectCallback.md deleted file mode 100644 index 987c3c41358..00000000000 --- a/website/docs/sdk/informer/type-aliases/ObjectCallback.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ObjectCallback\ - -> **ObjectCallback**\<`T`\> = (`obj`) => `void` - -Defined in: [src/informer.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L6) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### obj - -`T` - -## Returns - -`void` diff --git a/website/docs/sdk/informer/type-aliases/UPDATE.md b/website/docs/sdk/informer/type-aliases/UPDATE.md deleted file mode 100644 index 0d7390faa94..00000000000 --- a/website/docs/sdk/informer/type-aliases/UPDATE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: UPDATE - -> **UPDATE** = *typeof* [`UPDATE`](../variables/UPDATE.md) - -Defined in: [src/informer.ts:14](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L14) diff --git a/website/docs/sdk/informer/variables/ADD.md b/website/docs/sdk/informer/variables/ADD.md deleted file mode 100644 index a83d4aa3ef6..00000000000 --- a/website/docs/sdk/informer/variables/ADD.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: ADD - -> `const` **ADD**: `"add"` = `'add'` - -Defined in: [src/informer.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L12) diff --git a/website/docs/sdk/informer/variables/CHANGE.md b/website/docs/sdk/informer/variables/CHANGE.md deleted file mode 100644 index 5756791d1ff..00000000000 --- a/website/docs/sdk/informer/variables/CHANGE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: CHANGE - -> `const` **CHANGE**: `"change"` = `'change'` - -Defined in: [src/informer.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L16) diff --git a/website/docs/sdk/informer/variables/CONNECT.md b/website/docs/sdk/informer/variables/CONNECT.md deleted file mode 100644 index 8e1b6f24bec..00000000000 --- a/website/docs/sdk/informer/variables/CONNECT.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: CONNECT - -> `const` **CONNECT**: `"connect"` = `'connect'` - -Defined in: [src/informer.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L22) diff --git a/website/docs/sdk/informer/variables/DELETE.md b/website/docs/sdk/informer/variables/DELETE.md deleted file mode 100644 index 683c0df820c..00000000000 --- a/website/docs/sdk/informer/variables/DELETE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: DELETE - -> `const` **DELETE**: `"delete"` = `'delete'` - -Defined in: [src/informer.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L18) diff --git a/website/docs/sdk/informer/variables/ERROR.md b/website/docs/sdk/informer/variables/ERROR.md deleted file mode 100644 index 11d69ae978b..00000000000 --- a/website/docs/sdk/informer/variables/ERROR.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: ERROR - -> `const` **ERROR**: `"error"` = `'error'` - -Defined in: [src/informer.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L25) diff --git a/website/docs/sdk/informer/variables/UPDATE.md b/website/docs/sdk/informer/variables/UPDATE.md deleted file mode 100644 index 4bf0d8c5011..00000000000 --- a/website/docs/sdk/informer/variables/UPDATE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: UPDATE - -> `const` **UPDATE**: `"update"` = `'update'` - -Defined in: [src/informer.ts:14](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/informer.ts#L14) diff --git a/website/docs/sdk/log/classes/Log.md b/website/docs/sdk/log/classes/Log.md deleted file mode 100644 index fcb23972b65..00000000000 --- a/website/docs/sdk/log/classes/Log.md +++ /dev/null @@ -1,105 +0,0 @@ -# Class: Log - -Defined in: [src/log.ts:84](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L84) - -## Constructors - -### Constructor - -> **new Log**(`config`): `Log` - -Defined in: [src/log.ts:87](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L87) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -#### Returns - -`Log` - -## Properties - -### config - -> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) - -Defined in: [src/log.ts:85](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L85) - -## Methods - -### log() - -#### Call Signature - -> **log**(`namespace`, `podName`, `containerName`, `stream`, `options?`): `Promise`\<`AbortController`\> - -Defined in: [src/log.ts:91](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L91) - -##### Parameters - -###### namespace - -`string` - -###### podName - -`string` - -###### containerName - -`string` - -###### stream - -`Writable` - -###### options? - -[`LogOptions`](../interfaces/LogOptions.md) - -##### Returns - -`Promise`\<`AbortController`\> - -#### Call Signature - -> **log**(`namespace`, `podName`, `containerName`, `stream`, `done`, `options?`): `Promise`\<`AbortController`\> - -Defined in: [src/log.ts:99](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L99) - -##### Parameters - -###### namespace - -`string` - -###### podName - -`string` - -###### containerName - -`string` - -###### stream - -`Writable` - -###### done - -(`err`) => `void` - -###### options? - -[`LogOptions`](../interfaces/LogOptions.md) - -##### Returns - -`Promise`\<`AbortController`\> - -##### Deprecated - -done callback is deprecated diff --git a/website/docs/sdk/log/functions/AddOptionsToSearchParams.md b/website/docs/sdk/log/functions/AddOptionsToSearchParams.md deleted file mode 100644 index 5d6929f3979..00000000000 --- a/website/docs/sdk/log/functions/AddOptionsToSearchParams.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: AddOptionsToSearchParams() - -> **AddOptionsToSearchParams**(`options`, `searchParams`): `URLSearchParams` \| `undefined` - -Defined in: [src/log.ts:55](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L55) - -## Parameters - -### options - -[`LogOptions`](../interfaces/LogOptions.md) \| `undefined` - -### searchParams - -`URLSearchParams` - -## Returns - -`URLSearchParams` \| `undefined` diff --git a/website/docs/sdk/log/index.md b/website/docs/sdk/log/index.md deleted file mode 100644 index fd0405bfa4d..00000000000 --- a/website/docs/sdk/log/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# log - -## Classes - -- [Log](classes/Log.md) - -## Interfaces - -- [LogOptions](interfaces/LogOptions.md) - -## Functions - -- [AddOptionsToSearchParams](functions/AddOptionsToSearchParams.md) diff --git a/website/docs/sdk/log/interfaces/LogOptions.md b/website/docs/sdk/log/interfaces/LogOptions.md deleted file mode 100644 index d37cbd841cc..00000000000 --- a/website/docs/sdk/log/interfaces/LogOptions.md +++ /dev/null @@ -1,88 +0,0 @@ -# Interface: LogOptions - -Defined in: [src/log.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L8) - -## Properties - -### follow? - -> `optional` **follow?**: `boolean` - -Defined in: [src/log.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L12) - -Follow the log stream of the pod. Defaults to false. - -*** - -### limitBytes? - -> `optional` **limitBytes?**: `number` - -Defined in: [src/log.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L18) - -If set, the number of bytes to read from the server before terminating the log output. This may not display a -complete final line of logging, and may return slightly more or slightly less than the specified limit. - -*** - -### pretty? - -> `optional` **pretty?**: `boolean` - -Defined in: [src/log.ts:23](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L23) - -If true, then the output is pretty printed. - -*** - -### previous? - -> `optional` **previous?**: `boolean` - -Defined in: [src/log.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L28) - -Return previous terminated container logs. Defaults to false. - -*** - -### sinceSeconds? - -> `optional` **sinceSeconds?**: `number` - -Defined in: [src/log.ts:35](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L35) - -A relative time in seconds before the current time from which to show logs. If this value precedes the time a -pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will -be returned. Only one of sinceSeconds or sinceTime may be specified. - -*** - -### sinceTime? - -> `optional` **sinceTime?**: `string` - -Defined in: [src/log.ts:41](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L41) - -Only return logs after a specific date (RFC3339). Defaults to all logs. -Only one of sinceSeconds or sinceTime may be specified. - -*** - -### tailLines? - -> `optional` **tailLines?**: `number` - -Defined in: [src/log.ts:47](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L47) - -If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation -of the container or sinceSeconds or sinceTime - -*** - -### timestamps? - -> `optional` **timestamps?**: `boolean` - -Defined in: [src/log.ts:52](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/log.ts#L52) - -If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. diff --git a/website/docs/sdk/metrics/classes/Metrics.md b/website/docs/sdk/metrics/classes/Metrics.md deleted file mode 100644 index d635ba0a9c9..00000000000 --- a/website/docs/sdk/metrics/classes/Metrics.md +++ /dev/null @@ -1,51 +0,0 @@ -# Class: Metrics - -Defined in: [src/metrics.ts:57](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L57) - -## Constructors - -### Constructor - -> **new Metrics**(`config`): `Metrics` - -Defined in: [src/metrics.ts:60](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L60) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -#### Returns - -`Metrics` - -## Methods - -### getNodeMetrics() - -> **getNodeMetrics**(): `Promise`\<[`NodeMetricsList`](../interfaces/NodeMetricsList.md)\> - -Defined in: [src/metrics.ts:64](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L64) - -#### Returns - -`Promise`\<[`NodeMetricsList`](../interfaces/NodeMetricsList.md)\> - -*** - -### getPodMetrics() - -> **getPodMetrics**(`namespace?`): `Promise`\<[`PodMetricsList`](../interfaces/PodMetricsList.md)\> - -Defined in: [src/metrics.ts:68](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L68) - -#### Parameters - -##### namespace? - -`string` - -#### Returns - -`Promise`\<[`PodMetricsList`](../interfaces/PodMetricsList.md)\> diff --git a/website/docs/sdk/metrics/index.md b/website/docs/sdk/metrics/index.md deleted file mode 100644 index 21d120f931e..00000000000 --- a/website/docs/sdk/metrics/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# metrics - -## Classes - -- [Metrics](classes/Metrics.md) - -## Interfaces - -- [ContainerMetric](interfaces/ContainerMetric.md) -- [NodeMetric](interfaces/NodeMetric.md) -- [NodeMetricsList](interfaces/NodeMetricsList.md) -- [PodMetric](interfaces/PodMetric.md) -- [PodMetricsList](interfaces/PodMetricsList.md) -- [Usage](interfaces/Usage.md) diff --git a/website/docs/sdk/metrics/interfaces/ContainerMetric.md b/website/docs/sdk/metrics/interfaces/ContainerMetric.md deleted file mode 100644 index af8a60e11ef..00000000000 --- a/website/docs/sdk/metrics/interfaces/ContainerMetric.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: ContainerMetric - -Defined in: [src/metrics.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L11) - -## Properties - -### name - -> **name**: `string` - -Defined in: [src/metrics.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L12) - -*** - -### usage - -> **usage**: [`Usage`](Usage.md) - -Defined in: [src/metrics.ts:13](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L13) diff --git a/website/docs/sdk/metrics/interfaces/NodeMetric.md b/website/docs/sdk/metrics/interfaces/NodeMetric.md deleted file mode 100644 index 5fdd68e52d0..00000000000 --- a/website/docs/sdk/metrics/interfaces/NodeMetric.md +++ /dev/null @@ -1,47 +0,0 @@ -# Interface: NodeMetric - -Defined in: [src/metrics.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L28) - -## Properties - -### metadata - -> **metadata**: `object` - -Defined in: [src/metrics.ts:29](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L29) - -#### creationTimestamp - -> **creationTimestamp**: `string` - -#### name - -> **name**: `string` - -#### selfLink - -> **selfLink**: `string` - -*** - -### timestamp - -> **timestamp**: `string` - -Defined in: [src/metrics.ts:34](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L34) - -*** - -### usage - -> **usage**: [`Usage`](Usage.md) - -Defined in: [src/metrics.ts:36](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L36) - -*** - -### window - -> **window**: `string` - -Defined in: [src/metrics.ts:35](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L35) diff --git a/website/docs/sdk/metrics/interfaces/NodeMetricsList.md b/website/docs/sdk/metrics/interfaces/NodeMetricsList.md deleted file mode 100644 index ebee94d3a88..00000000000 --- a/website/docs/sdk/metrics/interfaces/NodeMetricsList.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: NodeMetricsList - -Defined in: [src/metrics.ts:48](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L48) - -## Properties - -### apiVersion - -> **apiVersion**: `"metrics.k8s.io/v1beta1"` - -Defined in: [src/metrics.ts:50](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L50) - -*** - -### items - -> **items**: [`NodeMetric`](NodeMetric.md)[] - -Defined in: [src/metrics.ts:54](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L54) - -*** - -### kind - -> **kind**: `"NodeMetricsList"` - -Defined in: [src/metrics.ts:49](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L49) - -*** - -### metadata - -> **metadata**: `object` - -Defined in: [src/metrics.ts:51](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L51) - -#### selfLink - -> **selfLink**: `string` diff --git a/website/docs/sdk/metrics/interfaces/PodMetric.md b/website/docs/sdk/metrics/interfaces/PodMetric.md deleted file mode 100644 index 9e664b1b9ea..00000000000 --- a/website/docs/sdk/metrics/interfaces/PodMetric.md +++ /dev/null @@ -1,51 +0,0 @@ -# Interface: PodMetric - -Defined in: [src/metrics.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L16) - -## Properties - -### containers - -> **containers**: [`ContainerMetric`](ContainerMetric.md)[] - -Defined in: [src/metrics.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L25) - -*** - -### metadata - -> **metadata**: `object` - -Defined in: [src/metrics.ts:17](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L17) - -#### creationTimestamp - -> **creationTimestamp**: `string` - -#### name - -> **name**: `string` - -#### namespace - -> **namespace**: `string` - -#### selfLink - -> **selfLink**: `string` - -*** - -### timestamp - -> **timestamp**: `string` - -Defined in: [src/metrics.ts:23](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L23) - -*** - -### window - -> **window**: `string` - -Defined in: [src/metrics.ts:24](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L24) diff --git a/website/docs/sdk/metrics/interfaces/PodMetricsList.md b/website/docs/sdk/metrics/interfaces/PodMetricsList.md deleted file mode 100644 index 338d19239ee..00000000000 --- a/website/docs/sdk/metrics/interfaces/PodMetricsList.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: PodMetricsList - -Defined in: [src/metrics.ts:39](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L39) - -## Properties - -### apiVersion - -> **apiVersion**: `"metrics.k8s.io/v1beta1"` - -Defined in: [src/metrics.ts:41](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L41) - -*** - -### items - -> **items**: [`PodMetric`](PodMetric.md)[] - -Defined in: [src/metrics.ts:45](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L45) - -*** - -### kind - -> **kind**: `"PodMetricsList"` - -Defined in: [src/metrics.ts:40](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L40) - -*** - -### metadata - -> **metadata**: `object` - -Defined in: [src/metrics.ts:42](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L42) - -#### selfLink - -> **selfLink**: `string` diff --git a/website/docs/sdk/metrics/interfaces/Usage.md b/website/docs/sdk/metrics/interfaces/Usage.md deleted file mode 100644 index 0f04f4ca098..00000000000 --- a/website/docs/sdk/metrics/interfaces/Usage.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: Usage - -Defined in: [src/metrics.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L6) - -## Properties - -### cpu - -> **cpu**: `string` - -Defined in: [src/metrics.ts:7](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L7) - -*** - -### memory - -> **memory**: `string` - -Defined in: [src/metrics.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/metrics.ts#L8) diff --git a/website/docs/sdk/middleware/functions/setHeaderMiddleware.md b/website/docs/sdk/middleware/functions/setHeaderMiddleware.md deleted file mode 100644 index 8d035ae59eb..00000000000 --- a/website/docs/sdk/middleware/functions/setHeaderMiddleware.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: setHeaderMiddleware() - -> **setHeaderMiddleware**(`key`, `value`): `Middleware` - -Defined in: [src/middleware.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/middleware.ts#L9) - -## Parameters - -### key - -`string` - -### value - -`string` - -## Returns - -`Middleware` diff --git a/website/docs/sdk/middleware/functions/setHeaderOptions.md b/website/docs/sdk/middleware/functions/setHeaderOptions.md deleted file mode 100644 index 16600846d2e..00000000000 --- a/website/docs/sdk/middleware/functions/setHeaderOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -# Function: setHeaderOptions() - -> **setHeaderOptions**(`key`, `value`, `opt?`): `ConfigurationOptions`\<`Middleware`\> - -Defined in: [src/middleware.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/middleware.ts#L22) - -## Parameters - -### key - -`string` - -### value - -`string` - -### opt? - -`ConfigurationOptions`\<`Middleware`\> - -## Returns - -`ConfigurationOptions`\<`Middleware`\> diff --git a/website/docs/sdk/middleware/index.md b/website/docs/sdk/middleware/index.md deleted file mode 100644 index cffdb06008c..00000000000 --- a/website/docs/sdk/middleware/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# middleware - -## Functions - -- [setHeaderMiddleware](functions/setHeaderMiddleware.md) -- [setHeaderOptions](functions/setHeaderOptions.md) diff --git a/website/docs/sdk/object/classes/KubernetesObjectApi.md b/website/docs/sdk/object/classes/KubernetesObjectApi.md deleted file mode 100644 index 8076aba4eb0..00000000000 --- a/website/docs/sdk/object/classes/KubernetesObjectApi.md +++ /dev/null @@ -1,466 +0,0 @@ -# Class: KubernetesObjectApi - -Defined in: [src/object.ts:37](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L37) - -Dynamically construct Kubernetes API request URIs so client does not have to know what type of object it is acting -on. - -## Constructors - -### Constructor - -> **new KubernetesObjectApi**(`configuration`): `KubernetesObjectApi` - -Defined in: [src/object.ts:59](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L59) - -#### Parameters - -##### configuration - -`Configuration` - -#### Returns - -`KubernetesObjectApi` - -## Methods - -### create() - -> **create**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `options?`): `Promise`\<`T`\> - -Defined in: [src/object.ts:76](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L76) - -Create any Kubernetes resource. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### spec - -`T` - -Kubernetes resource spec. - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### dryRun? - -`string` - -When present, indicates that modifications should not be persisted. An invalid or unrecognized - dryRun directive will result in an error response and no further processing of the request. Valid values - are: - All: all dry run stages will be processed - -##### fieldManager? - -`string` - -fieldManager is a name associated with the actor or entity that is making these changes. The - value must be less than or 128 characters long, and only contain printable characters, as defined by - https://golang.org/pkg/unicode/#IsPrint. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`T`\> - -Promise containing the request response and [[KubernetesObject]]. - -*** - -### delete() - -> **delete**(`spec`, `pretty?`, `dryRun?`, `gracePeriodSeconds?`, `orphanDependents?`, `propagationPolicy?`, `body?`, `options?`): `Promise`\<`V1Status`\> - -Defined in: [src/object.ts:145](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L145) - -Delete any Kubernetes resource. - -#### Parameters - -##### spec - -[`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -Kubernetes resource spec - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### dryRun? - -`string` - -When present, indicates that modifications should not be persisted. An invalid or unrecognized - dryRun directive will result in an error response and no further processing of the request. Valid values - are: - All: all dry run stages will be processed - -##### gracePeriodSeconds? - -`number` - -The duration in seconds before the object should be deleted. Value must be non-negative - integer. The value zero indicates delete immediately. If this value is nil, the default grace period for - the specified type will be used. Defaults to a per object value if not specified. zero means delete - immediately. - -##### orphanDependents? - -`boolean` - -Deprecated: please use the PropagationPolicy, this field will be deprecated in - 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be - added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be - set, but not both. - -##### propagationPolicy? - -`string` - -Whether and how garbage collection will be performed. Either this field or - OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in - the metadata.finalizers and the resource-specific default policy. Acceptable values are: - \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete - the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents - in the foreground. - -##### body? - -`V1DeleteOptions` - -See [[V1DeleteOptions]]. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`V1Status`\> - -Promise containing the request response and a Kubernetes [[V1Status]]. - -*** - -### list() - -> **list**\<`T`\>(`apiVersion`, `kind`, `namespace?`, `pretty?`, `exact?`, `exportt?`, `fieldSelector?`, `labelSelector?`, `limit?`, `continueToken?`, `options?`): `Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> - -Defined in: [src/object.ts:349](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L349) - -List any Kubernetes resources. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### apiVersion - -`string` - -api group and version of the form / - -##### kind - -`string` - -Kubernetes resource kind - -##### namespace? - -`string` - -list resources in this namespace - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### exact? - -`boolean` - -Should the export be exact. Exact export maintains cluster-specific fields like - \'Namespace\'. Deprecated. Planned for removal in 1.18. - -##### exportt? - -`boolean` - -Should this value be exported. Export strips fields that a user can not - specify. Deprecated. Planned for removal in 1.18. - -##### fieldSelector? - -`string` - -A selector to restrict the list of returned objects by their fields. Defaults to everything. - -##### labelSelector? - -`string` - -A selector to restrict the list of returned objects by their labels. Defaults to everything. - -##### limit? - -`number` - -Number of returned resources. - -##### continueToken? - -`string` - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> - -Promise containing the request response and [[KubernetesListObject]]. - -*** - -### patch() - -> **patch**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `force?`, `patchStrategy?`, `options?`): `Promise`\<`T`\> - -Defined in: [src/object.ts:230](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L230) - -Patch any Kubernetes resource. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### spec - -`T` - -Kubernetes resource spec - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### dryRun? - -`string` - -When present, indicates that modifications should not be persisted. An invalid or unrecognized - dryRun directive will result in an error response and no further processing of the request. Valid values - are: - All: all dry run stages will be processed - -##### fieldManager? - -`string` - -fieldManager is a name associated with the actor or entity that is making these changes. The - value must be less than or 128 characters long, and only contain printable characters, as defined by - https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests - (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, - StrategicMergePatch). - -##### force? - -`boolean` - -Force is going to \"force\" Apply requests. It means user will re-acquire conflicting - fields owned by other people. Force flag must be unset for non-apply patch requests. - -##### patchStrategy? - -[`PatchStrategy`](../../patch/type-aliases/PatchStrategy.md) = `PatchStrategy.StrategicMergePatch` - -Content-Type header used to control how the patch will be performed. See - See https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ - for details. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`T`\> - -Promise containing the request response and [[KubernetesObject]]. - -*** - -### read() - -> **read**\<`T`\>(`spec`, `pretty?`, `exact?`, `exportt?`, `options?`): `Promise`\<`T`\> - -Defined in: [src/object.ts:292](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L292) - -Read any Kubernetes resource. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### spec - -`KubernetesObjectHeader`\<`T`\> - -Kubernetes resource spec - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### exact? - -`boolean` - -Should the export be exact. Exact export maintains cluster-specific fields like - \'Namespace\'. Deprecated. Planned for removal in 1.18. - -##### exportt? - -`boolean` - -Should this value be exported. Export strips fields that a user can not - specify. Deprecated. Planned for removal in 1.18. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`T`\> - -Promise containing the request response and [[KubernetesObject]]. - -*** - -### replace() - -> **replace**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `options?`): `Promise`\<`T`\> - -Defined in: [src/object.ts:436](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L436) - -Replace any Kubernetes resource. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### spec - -`T` - -Kubernetes resource spec - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### dryRun? - -`string` - -When present, indicates that modifications should not be persisted. An invalid or unrecognized - dryRun directive will result in an error response and no further processing of the request. Valid values - are: - All: all dry run stages will be processed - -##### fieldManager? - -`string` - -fieldManager is a name associated with the actor or entity that is making these changes. The - value must be less than or 128 characters long, and only contain printable characters, as defined by - https://golang.org/pkg/unicode/#IsPrint. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`T`\> - -Promise containing the request response and [[KubernetesObject]]. - -*** - -### makeApiClient() - -> `static` **makeApiClient**(`kc`): `KubernetesObjectApi` - -Defined in: [src/object.ts:46](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/object.ts#L46) - -Create a KubernetesObjectApi object from the provided KubeConfig. This method should be used rather than -[[KubeConfig.makeApiClient]] so we can properly determine the default namespace if one is provided by the current -context. - -#### Parameters - -##### kc - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -Valid Kubernetes config - -#### Returns - -`KubernetesObjectApi` - -Properly instantiated [[KubernetesObjectApi]] object diff --git a/website/docs/sdk/object/index.md b/website/docs/sdk/object/index.md deleted file mode 100644 index 82633830a1e..00000000000 --- a/website/docs/sdk/object/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# object - -## Classes - -- [KubernetesObjectApi](classes/KubernetesObjectApi.md) diff --git a/website/docs/sdk/patch/index.md b/website/docs/sdk/patch/index.md deleted file mode 100644 index 33a10aae72b..00000000000 --- a/website/docs/sdk/patch/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# patch - -## Type Aliases - -- [PatchStrategy](type-aliases/PatchStrategy.md) - -## Variables - -- [PatchStrategy](variables/PatchStrategy.md) diff --git a/website/docs/sdk/patch/type-aliases/PatchStrategy.md b/website/docs/sdk/patch/type-aliases/PatchStrategy.md deleted file mode 100644 index 8ca2a4a25f1..00000000000 --- a/website/docs/sdk/patch/type-aliases/PatchStrategy.md +++ /dev/null @@ -1,12 +0,0 @@ -# Type Alias: PatchStrategy - -> **PatchStrategy** = *typeof* [`PatchStrategy`](../variables/PatchStrategy.md)\[keyof *typeof* [`PatchStrategy`](../variables/PatchStrategy.md)\] - -Defined in: [src/patch.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/patch.ts#L9) - -Valid Content-Type header values for patch operations. See -https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ -for details. - -Additionally for Server-Side Apply https://kubernetes.io/docs/reference/using-api/server-side-apply/ -and https://kubernetes.io/docs/reference/using-api/server-side-apply/#api-implementation diff --git a/website/docs/sdk/patch/variables/PatchStrategy.md b/website/docs/sdk/patch/variables/PatchStrategy.md deleted file mode 100644 index 599906fec57..00000000000 --- a/website/docs/sdk/patch/variables/PatchStrategy.md +++ /dev/null @@ -1,38 +0,0 @@ -# Variable: PatchStrategy - -> `const` **PatchStrategy**: `object` - -Defined in: [src/patch.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/patch.ts#L9) - -Valid Content-Type header values for patch operations. See -https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ -for details. - -Additionally for Server-Side Apply https://kubernetes.io/docs/reference/using-api/server-side-apply/ -and https://kubernetes.io/docs/reference/using-api/server-side-apply/#api-implementation - -## Type Declaration - -### JsonPatch - -> `readonly` **JsonPatch**: `"application/json-patch+json"` = `'application/json-patch+json'` - -Diff-like JSON format. - -### MergePatch - -> `readonly` **MergePatch**: `"application/merge-patch+json"` = `'application/merge-patch+json'` - -Simple merge. - -### ServerSideApply - -> `readonly` **ServerSideApply**: `"application/apply-patch+yaml"` = `'application/apply-patch+yaml'` - -Server-Side Apply - -### StrategicMergePatch - -> `readonly` **StrategicMergePatch**: `"application/strategic-merge-patch+json"` = `'application/strategic-merge-patch+json'` - -Merge with different strategies depending on field metadata. diff --git a/website/docs/sdk/portforward/classes/PortForward.md b/website/docs/sdk/portforward/classes/PortForward.md deleted file mode 100644 index 36f581c6015..00000000000 --- a/website/docs/sdk/portforward/classes/PortForward.md +++ /dev/null @@ -1,195 +0,0 @@ -# Class: PortForward - -Defined in: [src/portforward.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L9) - -## Constructors - -### Constructor - -> **new PortForward**(`config`, `disconnectOnErr?`, `handler?`): `PortForward` - -Defined in: [src/portforward.ts:15](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L15) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -##### disconnectOnErr? - -`boolean` - -##### handler? - -`WebSocketInterface` - -#### Returns - -`PortForward` - -## Methods - -### portForward() - -> **portForward**(`namespace`, `podName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> - -Defined in: [src/portforward.ts:22](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L22) - -#### Parameters - -##### namespace - -`string` - -##### podName - -`string` - -##### targetPorts - -`number`[] - -##### output - -`Writable` - -##### err - -`Writable` \| `null` - -##### input - -`Readable` - -##### retryCount? - -`number` = `0` - -#### Returns - -`Promise`\<`any`\> - -*** - -### portForwardDeployment() - -> **portForwardDeployment**(`namespace`, `deploymentName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> - -Defined in: [src/portforward.ts:123](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L123) - -Port forward to a deployment by resolving to the first ready pod selected by the deployment's selector. - -#### Parameters - -##### namespace - -`string` - -The namespace of the deployment - -##### deploymentName - -`string` - -The name of the deployment - -##### targetPorts - -`number`[] - -The target ports to forward to - -##### output - -`Writable` - -The writable stream for output - -##### err - -`Writable` \| `null` - -The writable stream for error output (can be null) - -##### input - -`Readable` - -The readable stream for input - -##### retryCount? - -`number` = `0` - -The number of times to retry the connection - -#### Returns - -`Promise`\<`any`\> - -#### Throws - -Will throw an error if the deployment is not found or has no ready pods - -*** - -### portForwardService() - -> **portForwardService**(`namespace`, `serviceName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> - -Defined in: [src/portforward.ts:89](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/portforward.ts#L89) - -Port forward to a service by resolving to the first ready pod selected by the service's selector. - -#### Parameters - -##### namespace - -`string` - -The namespace of the service - -##### serviceName - -`string` - -The name of the service - -##### targetPorts - -`number`[] - -The target ports to forward to - -##### output - -`Writable` - -The writable stream for output - -##### err - -`Writable` \| `null` - -The writable stream for error output (can be null) - -##### input - -`Readable` - -The readable stream for input - -##### retryCount? - -`number` = `0` - -The number of times to retry the connection - -#### Returns - -`Promise`\<`any`\> - -#### Throws - -Will throw an error if the service is not found or has no ready pods diff --git a/website/docs/sdk/portforward/index.md b/website/docs/sdk/portforward/index.md deleted file mode 100644 index 5330431e384..00000000000 --- a/website/docs/sdk/portforward/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# portforward - -## Classes - -- [PortForward](classes/PortForward.md) diff --git a/website/docs/sdk/top/classes/ContainerStatus.md b/website/docs/sdk/top/classes/ContainerStatus.md deleted file mode 100644 index eec54601d3b..00000000000 --- a/website/docs/sdk/top/classes/ContainerStatus.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: ContainerStatus - -Defined in: [src/top.ts:49](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L49) - -## Constructors - -### Constructor - -> **new ContainerStatus**(`Container`, `CPUUsage`, `MemoryUsage`): `ContainerStatus` - -Defined in: [src/top.ts:54](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L54) - -#### Parameters - -##### Container - -`string` - -##### CPUUsage - -[`CurrentResourceUsage`](CurrentResourceUsage.md) - -##### MemoryUsage - -[`CurrentResourceUsage`](CurrentResourceUsage.md) - -#### Returns - -`ContainerStatus` - -## Properties - -### Container - -> `readonly` **Container**: `string` - -Defined in: [src/top.ts:50](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L50) - -*** - -### CPUUsage - -> `readonly` **CPUUsage**: [`CurrentResourceUsage`](CurrentResourceUsage.md) - -Defined in: [src/top.ts:51](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L51) - -*** - -### MemoryUsage - -> `readonly` **MemoryUsage**: [`CurrentResourceUsage`](CurrentResourceUsage.md) - -Defined in: [src/top.ts:52](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L52) diff --git a/website/docs/sdk/top/classes/CurrentResourceUsage.md b/website/docs/sdk/top/classes/CurrentResourceUsage.md deleted file mode 100644 index b8fbff0001d..00000000000 --- a/website/docs/sdk/top/classes/CurrentResourceUsage.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: CurrentResourceUsage - -Defined in: [src/top.ts:25](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L25) - -## Constructors - -### Constructor - -> **new CurrentResourceUsage**(`CurrentUsage`, `RequestTotal`, `LimitTotal`): `CurrentResourceUsage` - -Defined in: [src/top.ts:30](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L30) - -#### Parameters - -##### CurrentUsage - -`number` \| `bigint` - -##### RequestTotal - -`number` \| `bigint` - -##### LimitTotal - -`number` \| `bigint` - -#### Returns - -`CurrentResourceUsage` - -## Properties - -### CurrentUsage - -> `readonly` **CurrentUsage**: `number` \| `bigint` - -Defined in: [src/top.ts:26](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L26) - -*** - -### LimitTotal - -> `readonly` **LimitTotal**: `number` \| `bigint` - -Defined in: [src/top.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L28) - -*** - -### RequestTotal - -> `readonly` **RequestTotal**: `number` \| `bigint` - -Defined in: [src/top.ts:27](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L27) diff --git a/website/docs/sdk/top/classes/NodeStatus.md b/website/docs/sdk/top/classes/NodeStatus.md deleted file mode 100644 index 2ef996fa6a5..00000000000 --- a/website/docs/sdk/top/classes/NodeStatus.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: NodeStatus - -Defined in: [src/top.ts:37](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L37) - -## Constructors - -### Constructor - -> **new NodeStatus**(`Node`, `CPU`, `Memory`): `NodeStatus` - -Defined in: [src/top.ts:42](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L42) - -#### Parameters - -##### Node - -`V1Node` - -##### CPU - -[`ResourceUsage`](ResourceUsage.md) - -##### Memory - -[`ResourceUsage`](ResourceUsage.md) - -#### Returns - -`NodeStatus` - -## Properties - -### CPU - -> `readonly` **CPU**: [`ResourceUsage`](ResourceUsage.md) - -Defined in: [src/top.ts:39](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L39) - -*** - -### Memory - -> `readonly` **Memory**: [`ResourceUsage`](ResourceUsage.md) - -Defined in: [src/top.ts:40](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L40) - -*** - -### Node - -> `readonly` **Node**: `V1Node` - -Defined in: [src/top.ts:38](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L38) diff --git a/website/docs/sdk/top/classes/PodStatus.md b/website/docs/sdk/top/classes/PodStatus.md deleted file mode 100644 index e86261de776..00000000000 --- a/website/docs/sdk/top/classes/PodStatus.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: PodStatus - -Defined in: [src/top.ts:61](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L61) - -## Constructors - -### Constructor - -> **new PodStatus**(`Pod`, `CPU`, `Memory`, `Containers`): `PodStatus` - -Defined in: [src/top.ts:67](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L67) - -#### Parameters - -##### Pod - -`V1Pod` - -##### CPU - -[`CurrentResourceUsage`](CurrentResourceUsage.md) - -##### Memory - -[`CurrentResourceUsage`](CurrentResourceUsage.md) - -##### Containers - -[`ContainerStatus`](ContainerStatus.md)[] - -#### Returns - -`PodStatus` - -## Properties - -### Containers - -> `readonly` **Containers**: [`ContainerStatus`](ContainerStatus.md)[] - -Defined in: [src/top.ts:65](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L65) - -*** - -### CPU - -> `readonly` **CPU**: [`CurrentResourceUsage`](CurrentResourceUsage.md) - -Defined in: [src/top.ts:63](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L63) - -*** - -### Memory - -> `readonly` **Memory**: [`CurrentResourceUsage`](CurrentResourceUsage.md) - -Defined in: [src/top.ts:64](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L64) - -*** - -### Pod - -> `readonly` **Pod**: `V1Pod` - -Defined in: [src/top.ts:62](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L62) diff --git a/website/docs/sdk/top/classes/ResourceUsage.md b/website/docs/sdk/top/classes/ResourceUsage.md deleted file mode 100644 index 70e2ae3caeb..00000000000 --- a/website/docs/sdk/top/classes/ResourceUsage.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: ResourceUsage - -Defined in: [src/top.ts:13](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L13) - -## Constructors - -### Constructor - -> **new ResourceUsage**(`Capacity`, `RequestTotal`, `LimitTotal`): `ResourceUsage` - -Defined in: [src/top.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L18) - -#### Parameters - -##### Capacity - -`number` \| `bigint` - -##### RequestTotal - -`number` \| `bigint` - -##### LimitTotal - -`number` \| `bigint` - -#### Returns - -`ResourceUsage` - -## Properties - -### Capacity - -> `readonly` **Capacity**: `number` \| `bigint` - -Defined in: [src/top.ts:14](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L14) - -*** - -### LimitTotal - -> `readonly` **LimitTotal**: `number` \| `bigint` - -Defined in: [src/top.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L16) - -*** - -### RequestTotal - -> `readonly` **RequestTotal**: `number` \| `bigint` - -Defined in: [src/top.ts:15](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L15) diff --git a/website/docs/sdk/top/functions/topNodes.md b/website/docs/sdk/top/functions/topNodes.md deleted file mode 100644 index d198f3480fc..00000000000 --- a/website/docs/sdk/top/functions/topNodes.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: topNodes() - -> **topNodes**(`api`): `Promise`\<[`NodeStatus`](../classes/NodeStatus.md)[]\> - -Defined in: [src/top.ts:80](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L80) - -## Parameters - -### api - -`ObjectCoreV1Api` - -## Returns - -`Promise`\<[`NodeStatus`](../classes/NodeStatus.md)[]\> diff --git a/website/docs/sdk/top/functions/topPods.md b/website/docs/sdk/top/functions/topPods.md deleted file mode 100644 index 5424227a4fd..00000000000 --- a/website/docs/sdk/top/functions/topPods.md +++ /dev/null @@ -1,23 +0,0 @@ -# Function: topPods() - -> **topPods**(`api`, `metrics`, `namespace?`): `Promise`\<[`PodStatus`](../classes/PodStatus.md)[]\> - -Defined in: [src/top.ts:111](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/top.ts#L111) - -## Parameters - -### api - -`ObjectCoreV1Api` - -### metrics - -[`Metrics`](../../metrics/classes/Metrics.md) - -### namespace? - -`string` - -## Returns - -`Promise`\<[`PodStatus`](../classes/PodStatus.md)[]\> diff --git a/website/docs/sdk/top/index.md b/website/docs/sdk/top/index.md deleted file mode 100644 index dda791b768b..00000000000 --- a/website/docs/sdk/top/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# top - -## Classes - -- [ContainerStatus](classes/ContainerStatus.md) -- [CurrentResourceUsage](classes/CurrentResourceUsage.md) -- [NodeStatus](classes/NodeStatus.md) -- [PodStatus](classes/PodStatus.md) -- [ResourceUsage](classes/ResourceUsage.md) - -## Functions - -- [topNodes](functions/topNodes.md) -- [topPods](functions/topPods.md) diff --git a/website/docs/sdk/typedoc-sidebar.cjs b/website/docs/sdk/typedoc-sidebar.cjs deleted file mode 100644 index 575b5c88e97..00000000000 --- a/website/docs/sdk/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"attach",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/attach/classes/Attach",label:"Attach"}]}],link:{type:"doc",id:"sdk/attach/index"}},{type:"category",label:"cache",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/cache/classes/ListWatch",label:"ListWatch"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/cache/interfaces/ObjectCache",label:"ObjectCache"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/cache/type-aliases/CacheMap",label:"CacheMap"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/cache/functions/addOrUpdateObject",label:"addOrUpdateObject"},{type:"doc",id:"sdk/cache/functions/cacheMapFromList",label:"cacheMapFromList"},{type:"doc",id:"sdk/cache/functions/deleteItems",label:"deleteItems"},{type:"doc",id:"sdk/cache/functions/deleteObject",label:"deleteObject"}]}],link:{type:"doc",id:"sdk/cache/index"}},{type:"category",label:"config",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/config/classes/KubeConfig",label:"KubeConfig"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/config/interfaces/ApiType",label:"ApiType"},{type:"doc",id:"sdk/config/interfaces/Named",label:"Named"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/config/type-aliases/ApiConstructor",label:"ApiConstructor"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/config/functions/bufferFromFileOrString",label:"bufferFromFileOrString"},{type:"doc",id:"sdk/config/functions/findHomeDir",label:"findHomeDir"},{type:"doc",id:"sdk/config/functions/findObject",label:"findObject"},{type:"doc",id:"sdk/config/functions/makeAbsolutePath",label:"makeAbsolutePath"}]}],link:{type:"doc",id:"sdk/config/index"}},{type:"category",label:"config_types",items:[{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/config_types/interfaces/Cluster",label:"Cluster"},{type:"doc",id:"sdk/config_types/interfaces/ConfigOptions",label:"ConfigOptions"},{type:"doc",id:"sdk/config_types/interfaces/Context",label:"Context"},{type:"doc",id:"sdk/config_types/interfaces/User",label:"User"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/config_types/type-aliases/ActionOnInvalid",label:"ActionOnInvalid"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/config_types/variables/ActionOnInvalid",label:"ActionOnInvalid"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/config_types/functions/exportCluster",label:"exportCluster"},{type:"doc",id:"sdk/config_types/functions/exportContext",label:"exportContext"},{type:"doc",id:"sdk/config_types/functions/exportUser",label:"exportUser"},{type:"doc",id:"sdk/config_types/functions/newClusters",label:"newClusters"},{type:"doc",id:"sdk/config_types/functions/newContexts",label:"newContexts"},{type:"doc",id:"sdk/config_types/functions/newUsers",label:"newUsers"}]}],link:{type:"doc",id:"sdk/config_types/index"}},{type:"category",label:"cp",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/cp/classes/Cp",label:"Cp"}]}],link:{type:"doc",id:"sdk/cp/index"}},{type:"category",label:"exec",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/exec/classes/Exec",label:"Exec"}]}],link:{type:"doc",id:"sdk/exec/index"}},{type:"category",label:"health",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/health/classes/Health",label:"Health"}]}],link:{type:"doc",id:"sdk/health/index"}},{type:"category",label:"informer",items:[{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/informer/interfaces/Informer",label:"Informer"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/informer/type-aliases/ADD",label:"ADD"},{type:"doc",id:"sdk/informer/type-aliases/CHANGE",label:"CHANGE"},{type:"doc",id:"sdk/informer/type-aliases/CONNECT",label:"CONNECT"},{type:"doc",id:"sdk/informer/type-aliases/DELETE",label:"DELETE"},{type:"doc",id:"sdk/informer/type-aliases/ERROR",label:"ERROR"},{type:"doc",id:"sdk/informer/type-aliases/ErrorCallback",label:"ErrorCallback"},{type:"doc",id:"sdk/informer/type-aliases/ListCallback",label:"ListCallback"},{type:"doc",id:"sdk/informer/type-aliases/ListPromise",label:"ListPromise"},{type:"doc",id:"sdk/informer/type-aliases/ObjectCallback",label:"ObjectCallback"},{type:"doc",id:"sdk/informer/type-aliases/UPDATE",label:"UPDATE"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/informer/variables/ADD",label:"ADD"},{type:"doc",id:"sdk/informer/variables/CHANGE",label:"CHANGE"},{type:"doc",id:"sdk/informer/variables/CONNECT",label:"CONNECT"},{type:"doc",id:"sdk/informer/variables/DELETE",label:"DELETE"},{type:"doc",id:"sdk/informer/variables/ERROR",label:"ERROR"},{type:"doc",id:"sdk/informer/variables/UPDATE",label:"UPDATE"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/informer/functions/makeInformer",label:"makeInformer"}]}],link:{type:"doc",id:"sdk/informer/index"}},{type:"category",label:"log",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/log/classes/Log",label:"Log"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/log/interfaces/LogOptions",label:"LogOptions"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/log/functions/AddOptionsToSearchParams",label:"AddOptionsToSearchParams"}]}],link:{type:"doc",id:"sdk/log/index"}},{type:"category",label:"metrics",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/metrics/classes/Metrics",label:"Metrics"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/metrics/interfaces/ContainerMetric",label:"ContainerMetric"},{type:"doc",id:"sdk/metrics/interfaces/NodeMetric",label:"NodeMetric"},{type:"doc",id:"sdk/metrics/interfaces/NodeMetricsList",label:"NodeMetricsList"},{type:"doc",id:"sdk/metrics/interfaces/PodMetric",label:"PodMetric"},{type:"doc",id:"sdk/metrics/interfaces/PodMetricsList",label:"PodMetricsList"},{type:"doc",id:"sdk/metrics/interfaces/Usage",label:"Usage"}]}],link:{type:"doc",id:"sdk/metrics/index"}},{type:"category",label:"middleware",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/middleware/functions/setHeaderMiddleware",label:"setHeaderMiddleware"},{type:"doc",id:"sdk/middleware/functions/setHeaderOptions",label:"setHeaderOptions"}]}],link:{type:"doc",id:"sdk/middleware/index"}},{type:"category",label:"object",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/object/classes/KubernetesObjectApi",label:"KubernetesObjectApi"}]}],link:{type:"doc",id:"sdk/object/index"}},{type:"category",label:"patch",items:[{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/patch/type-aliases/PatchStrategy",label:"PatchStrategy"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/patch/variables/PatchStrategy",label:"PatchStrategy"}]}],link:{type:"doc",id:"sdk/patch/index"}},{type:"category",label:"portforward",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/portforward/classes/PortForward",label:"PortForward"}]}],link:{type:"doc",id:"sdk/portforward/index"}},{type:"category",label:"top",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/top/classes/ContainerStatus",label:"ContainerStatus"},{type:"doc",id:"sdk/top/classes/CurrentResourceUsage",label:"CurrentResourceUsage"},{type:"doc",id:"sdk/top/classes/NodeStatus",label:"NodeStatus"},{type:"doc",id:"sdk/top/classes/PodStatus",label:"PodStatus"},{type:"doc",id:"sdk/top/classes/ResourceUsage",label:"ResourceUsage"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/top/functions/topNodes",label:"topNodes"},{type:"doc",id:"sdk/top/functions/topPods",label:"topPods"}]}],link:{type:"doc",id:"sdk/top/index"}},{type:"category",label:"types",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/types/classes/V1MicroTime",label:"V1MicroTime"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/types/interfaces/KubernetesListObject",label:"KubernetesListObject"},{type:"doc",id:"sdk/types/interfaces/KubernetesObject",label:"KubernetesObject"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/types/type-aliases/IntOrString",label:"IntOrString"}]}],link:{type:"doc",id:"sdk/types/index"}},{type:"category",label:"watch",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/watch/classes/Watch",label:"Watch"}]}],link:{type:"doc",id:"sdk/watch/index"}},{type:"category",label:"yaml",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/yaml/functions/dumpYaml",label:"dumpYaml"},{type:"doc",id:"sdk/yaml/functions/loadAllYaml",label:"loadAllYaml"},{type:"doc",id:"sdk/yaml/functions/loadYaml",label:"loadYaml"}]}],link:{type:"doc",id:"sdk/yaml/index"}}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/website/docs/sdk/types/classes/V1MicroTime.md b/website/docs/sdk/types/classes/V1MicroTime.md deleted file mode 100644 index 90f2d773310..00000000000 --- a/website/docs/sdk/types/classes/V1MicroTime.md +++ /dev/null @@ -1,141 +0,0 @@ -# Class: V1MicroTime - -Defined in: [src/types.ts:18](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L18) - -## Extends - -- `Date` - -## Constructors - -### Constructor - -> **new V1MicroTime**(): `V1MicroTime` - -Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:926 - -#### Returns - -`V1MicroTime` - -#### Inherited from - -`Date.constructor` - -### Constructor - -> **new V1MicroTime**(`value`): `V1MicroTime` - -Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:927 - -#### Parameters - -##### value - -`string` \| `number` - -#### Returns - -`V1MicroTime` - -#### Inherited from - -`Date.constructor` - -### Constructor - -> **new V1MicroTime**(`year`, `monthIndex`, `date?`, `hours?`, `minutes?`, `seconds?`, `ms?`): `V1MicroTime` - -Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:938 - -Creates a new Date. - -#### Parameters - -##### year - -`number` - -The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year. - -##### monthIndex - -`number` - -The month as a number between 0 and 11 (January to December). - -##### date? - -`number` - -The date as a number between 1 and 31. - -##### hours? - -`number` - -Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour. - -##### minutes? - -`number` - -Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes. - -##### seconds? - -`number` - -Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds. - -##### ms? - -`number` - -A number from 0 to 999 that specifies the milliseconds. - -#### Returns - -`V1MicroTime` - -#### Inherited from - -`Date.constructor` - -### Constructor - -> **new V1MicroTime**(`value`): `V1MicroTime` - -Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:926 - -#### Parameters - -##### value - -`string` \| `number` \| `Date` - -#### Returns - -`V1MicroTime` - -#### Inherited from - -`Date.constructor` - -## Methods - -### toISOString() - -> **toISOString**(): `string` - -Defined in: [src/types.ts:19](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L19) - -Returns a date as a string value in ISO format. - -#### Returns - -`string` - -#### Overrides - -`Date.toISOString` diff --git a/website/docs/sdk/types/index.md b/website/docs/sdk/types/index.md deleted file mode 100644 index cdc701721b3..00000000000 --- a/website/docs/sdk/types/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# types - -## Classes - -- [V1MicroTime](classes/V1MicroTime.md) - -## Interfaces - -- [KubernetesListObject](interfaces/KubernetesListObject.md) -- [KubernetesObject](interfaces/KubernetesObject.md) - -## Type Aliases - -- [IntOrString](type-aliases/IntOrString.md) diff --git a/website/docs/sdk/types/interfaces/KubernetesListObject.md b/website/docs/sdk/types/interfaces/KubernetesListObject.md deleted file mode 100644 index d195cace2af..00000000000 --- a/website/docs/sdk/types/interfaces/KubernetesListObject.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: KubernetesListObject\ - -Defined in: [src/types.ts:9](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L9) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](KubernetesObject.md) - -## Properties - -### apiVersion? - -> `optional` **apiVersion?**: `string` - -Defined in: [src/types.ts:10](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L10) - -*** - -### items - -> **items**: `T`[] - -Defined in: [src/types.ts:13](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L13) - -*** - -### kind? - -> `optional` **kind?**: `string` - -Defined in: [src/types.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L11) - -*** - -### metadata? - -> `optional` **metadata?**: `V1ListMeta` - -Defined in: [src/types.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L12) diff --git a/website/docs/sdk/types/interfaces/KubernetesObject.md b/website/docs/sdk/types/interfaces/KubernetesObject.md deleted file mode 100644 index fffe5e5fac2..00000000000 --- a/website/docs/sdk/types/interfaces/KubernetesObject.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: KubernetesObject - -Defined in: [src/types.ts:3](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L3) - -## Properties - -### apiVersion? - -> `optional` **apiVersion?**: `string` - -Defined in: [src/types.ts:4](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L4) - -*** - -### kind? - -> `optional` **kind?**: `string` - -Defined in: [src/types.ts:5](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L5) - -*** - -### metadata? - -> `optional` **metadata?**: `V1ObjectMeta` - -Defined in: [src/types.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L6) diff --git a/website/docs/sdk/types/type-aliases/IntOrString.md b/website/docs/sdk/types/type-aliases/IntOrString.md deleted file mode 100644 index 3abe61135a7..00000000000 --- a/website/docs/sdk/types/type-aliases/IntOrString.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: IntOrString - -> **IntOrString** = `number` \| `string` - -Defined in: [src/types.ts:16](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/types.ts#L16) diff --git a/website/docs/sdk/watch/classes/Watch.md b/website/docs/sdk/watch/classes/Watch.md deleted file mode 100644 index 802f4d068ee..00000000000 --- a/website/docs/sdk/watch/classes/Watch.md +++ /dev/null @@ -1,67 +0,0 @@ -# Class: Watch - -Defined in: [src/watch.ts:6](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L6) - -## Constructors - -### Constructor - -> **new Watch**(`config`): `Watch` - -Defined in: [src/watch.ts:11](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L11) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -#### Returns - -`Watch` - -## Properties - -### config - -> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) - -Defined in: [src/watch.ts:8](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L8) - -*** - -### SERVER\_SIDE\_CLOSE - -> `static` **SERVER\_SIDE\_CLOSE**: `object` - -Defined in: [src/watch.ts:7](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L7) - -## Methods - -### watch() - -> **watch**(`path`, `queryParams`, `callback`, `done`): `Promise`\<`AbortController`\> - -Defined in: [src/watch.ts:21](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/watch.ts#L21) - -#### Parameters - -##### path - -`string` - -##### queryParams - -`Record`\<`string`, `string` \| `number` \| `boolean` \| `undefined`\> - -##### callback - -(`phase`, `apiObj`, `watchObj?`) => `void` - -##### done - -(`err`) => `void` - -#### Returns - -`Promise`\<`AbortController`\> diff --git a/website/docs/sdk/watch/index.md b/website/docs/sdk/watch/index.md deleted file mode 100644 index 6c5ddb17669..00000000000 --- a/website/docs/sdk/watch/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# watch - -## Classes - -- [Watch](classes/Watch.md) diff --git a/website/docs/sdk/yaml/functions/dumpYaml.md b/website/docs/sdk/yaml/functions/dumpYaml.md deleted file mode 100644 index 840366e5bea..00000000000 --- a/website/docs/sdk/yaml/functions/dumpYaml.md +++ /dev/null @@ -1,27 +0,0 @@ -# Function: dumpYaml() - -> **dumpYaml**(`object`, `opts?`): `string` - -Defined in: [src/yaml.ts:43](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/yaml.ts#L43) - -Dump a Kubernetes object to YAML. - -## Parameters - -### object - -`any` - -The Kubernetes object to dump. - -### opts? - -`any` - -Optional YAML dump options. - -## Returns - -`string` - -The YAML string representation of the serialized Kubernetes object. diff --git a/website/docs/sdk/yaml/functions/loadAllYaml.md b/website/docs/sdk/yaml/functions/loadAllYaml.md deleted file mode 100644 index cf273aecedf..00000000000 --- a/website/docs/sdk/yaml/functions/loadAllYaml.md +++ /dev/null @@ -1,27 +0,0 @@ -# Function: loadAllYaml() - -> **loadAllYaml**(`data`, `opts?`): `any`[] - -Defined in: [src/yaml.ts:28](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/yaml.ts#L28) - -Load all Kubernetes objects from YAML. - -## Parameters - -### data - -`string` - -The YAML string to load. - -### opts? - -`any` - -Optional YAML load options. - -## Returns - -`any`[] - -An array of deserialized Kubernetes objects. diff --git a/website/docs/sdk/yaml/functions/loadYaml.md b/website/docs/sdk/yaml/functions/loadYaml.md deleted file mode 100644 index eb1533d24b9..00000000000 --- a/website/docs/sdk/yaml/functions/loadYaml.md +++ /dev/null @@ -1,33 +0,0 @@ -# Function: loadYaml() - -> **loadYaml**\<`T`\>(`data`, `opts?`): `T` - -Defined in: [src/yaml.ts:12](https://github.com/davidgamero/javascript/blob/e0fd9c7e722ede8cfc1a9d68a223a359233058ff/src/yaml.ts#L12) - -Load a Kubernetes object from YAML. - -## Type Parameters - -### T - -`T` - -## Parameters - -### data - -`string` - -The YAML string to load. - -### opts? - -`any` - -Optional YAML load options. - -## Returns - -`T` - -The deserialized Kubernetes object. diff --git a/website/docs/sdk/yaml/index.md b/website/docs/sdk/yaml/index.md deleted file mode 100644 index 016ec239289..00000000000 --- a/website/docs/sdk/yaml/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# yaml - -## Functions - -- [dumpYaml](functions/dumpYaml.md) -- [loadAllYaml](functions/loadAllYaml.md) -- [loadYaml](functions/loadYaml.md) diff --git a/website/package.json b/website/package.json index 6e7c4f4fe87..0c4a17de864 100644 --- a/website/package.json +++ b/website/package.json @@ -1,51 +1,53 @@ { - "name": "website", - "version": "0.0.0", - "private": true, - "scripts": { - "docusaurus": "docusaurus", - "start": "docusaurus start", - "build": "docusaurus build", - "swizzle": "docusaurus swizzle", - "deploy": "docusaurus deploy", - "clear": "docusaurus clear", - "serve": "docusaurus serve", - "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids", - "typecheck": "tsc" - }, - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/preset-classic": "3.9.2", - "@easyops-cn/docusaurus-search-local": "^0.55.1", - "@mdx-js/react": "^3.0.0", - "clsx": "^2.0.0", - "prism-react-renderer": "^2.3.0", - "react": "^19.0.0", - "react-dom": "^19.0.0" - }, - "devDependencies": { - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/tsconfig": "3.9.2", - "@docusaurus/types": "3.9.2", - "docusaurus-plugin-typedoc": "^1.4.2", - "typedoc": "^0.28.18", - "typedoc-plugin-markdown": "^4.11.0", - "typescript": "~5.6.2" - }, - "browserslist": { - "production": [ - ">0.5%", - "not dead", - "not op_mini all" - ], - "development": [ - "last 3 chrome version", - "last 3 firefox version", - "last 5 safari version" - ] - }, - "engines": { - "node": ">=20.0" - } + "name": "website", + "version": "0.0.0", + "private": true, + "scripts": { + "prebuild": "node scripts/transform-gen-docs.mjs", + "prestart": "node scripts/transform-gen-docs.mjs", + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids", + "typecheck": "tsc" + }, + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", + "@easyops-cn/docusaurus-search-local": "^0.55.1", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "prism-react-renderer": "^2.3.0", + "react": "^19.0.0", + "react-dom": "^19.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", + "@docusaurus/types": "3.9.2", + "docusaurus-plugin-typedoc": "^1.4.2", + "typedoc": "^0.28.18", + "typedoc-plugin-markdown": "^4.11.0", + "typescript": "~5.6.2" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" + ] + }, + "engines": { + "node": ">=20.0" + } } diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index 2e006d153b4..f9055368085 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -1,44 +1,81 @@ -import type {ReactNode} from 'react'; +import type { ReactNode } from 'react'; import clsx from 'clsx'; import Link from '@docusaurus/Link'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; import Heading from '@theme/Heading'; import styles from './index.module.css'; function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); - return ( -
-
- - {siteConfig.title} - -

{siteConfig.tagline}

-
- - Docusaurus Tutorial - 5min ⏱️ - -
-
-
- ); + const { siteConfig } = useDocusaurusContext(); + return ( +
+
+ + {siteConfig.title} + +

{siteConfig.tagline}

+
+ + Get Started + + + GitHub + +
+
+ npm install @kubernetes/client-node +
+
+
+ ); } export default function Home(): ReactNode { - const {siteConfig} = useDocusaurusContext(); - return ( - - -
- -
- - ); + const { siteConfig } = useDocusaurusContext(); + return ( + + +
+
+
+
+
+
+ Type Safe +

+ Written in TypeScript with full support for Kubernetes API objects and + types. +

+
+
+
+
+ Node.js Optimized +

+ Designed for server-side use with native support for KubeConfig and + Service Accounts. +

+
+
+
+
+ Official Client +

+ Maintained by the Kubernetes community as the standard JavaScript + implementation. +

+
+
+
+
+
+
+ + ); } From 6236822f427111929df5d20c7ee4bc799a349d2d Mon Sep 17 00:00:00 2001 From: David Gamero Date: Thu, 26 Mar 2026 17:38:08 -0400 Subject: [PATCH 04/11] docs: add versioning support with 2.0.0 stable snapshot Task 10: Docusaurus versioning with current (2.0.0 Next) and 2.0.0 stable - versions.json registry - versioned_docs/version-2.0.0/ snapshot (165 files) - versioned_sidebars/version-2.0.0-sidebars.json - docusaurus.config.ts lastVersion + version labels - 1.4.0 deferred (tag lacks pre-generated docs) --- website/docusaurus.config.ts | 11 + .../cluster/AdmissionregistrationApi.md | 62 + .../cluster/AdmissionregistrationV1Api.md | 3767 ++ .../AdmissionregistrationV1alpha1Api.md | 1750 + .../AdmissionregistrationV1beta1Api.md | 1750 + .../api-reference/cluster/ApiextensionsApi.md | 62 + .../cluster/ApiextensionsV1Api.md | 1484 + .../cluster/ApiregistrationApi.md | 62 + .../cluster/ApiregistrationV1Api.md | 1031 + .../api-reference/cluster/SchedulingApi.md | 62 + .../api-reference/cluster/SchedulingV1Api.md | 719 + .../cluster/SchedulingV1alpha1Api.md | 853 + .../api-reference/cluster/_category_.json | 4 + .../configuration-storage/CoordinationApi.md | 62 + .../CoordinationV1Api.md | 835 + .../CoordinationV1alpha2Api.md | 833 + .../CoordinationV1beta1Api.md | 833 + .../configuration-storage/PolicyApi.md | 62 + .../configuration-storage/PolicyV1Api.md | 1191 + .../configuration-storage/StorageApi.md | 62 + .../configuration-storage/StorageV1Api.md | 5308 +++ .../StorageV1beta1Api.md | 719 + .../StoragemigrationApi.md | 62 + .../StoragemigrationV1beta1Api.md | 1016 + .../configuration-storage/_category_.json | 4 + .../api-reference/core-resources/CoreApi.md | 62 + .../api-reference/core-resources/CoreV1Api.md | 39221 ++++++++++++++++ .../api-reference/core-resources/EventsApi.md | 62 + .../core-resources/EventsV1Api.md | 889 + .../api-reference/core-resources/NodeApi.md | 62 + .../api-reference/core-resources/NodeV1Api.md | 751 + .../core-resources/_category_.json | 4 + .../api-reference/networking/DiscoveryApi.md | 62 + .../networking/DiscoveryV1Api.md | 913 + .../api-reference/networking/NetworkingApi.md | 62 + .../networking/NetworkingV1Api.md | 4552 ++ .../networking/NetworkingV1beta1Api.md | 1675 + .../api-reference/networking/_category_.json | 4 + .../api-reference/other/ApisApi.md | 62 + .../api-reference/other/AutoscalingApi.md | 62 + .../api-reference/other/AutoscalingV1Api.md | 1125 + .../api-reference/other/AutoscalingV2Api.md | 1833 + .../api-reference/other/CustomObjectsApi.md | 2234 + .../other/FlowcontrolApiserverApi.md | 62 + .../other/FlowcontrolApiserverV1Api.md | 2147 + .../other/InternalApiserverApi.md | 62 + .../other/InternalApiserverV1alpha1Api.md | 1037 + .../api-reference/other/LogsApi.md | 111 + .../api-reference/other/OpenidApi.md | 62 + .../api-reference/other/ResourceApi.md | 62 + .../api-reference/other/ResourceV1Api.md | 4243 ++ .../other/ResourceV1alpha3Api.md | 1034 + .../api-reference/other/ResourceV1beta1Api.md | 4237 ++ .../api-reference/other/ResourceV1beta2Api.md | 4243 ++ .../api-reference/other/VersionApi.md | 62 + .../api-reference/other/WellKnownApi.md | 62 + .../api-reference/other/_category_.json | 4 + .../security/AuthenticationApi.md | 62 + .../security/AuthenticationV1Api.md | 329 + .../security/AuthorizationApi.md | 62 + .../security/AuthorizationV1Api.md | 709 + .../api-reference/security/CertificatesApi.md | 62 + .../security/CertificatesV1Api.md | 1331 + .../security/CertificatesV1alpha1Api.md | 719 + .../security/CertificatesV1beta1Api.md | 1824 + .../security/RbacAuthorizationApi.md | 62 + .../security/RbacAuthorizationV1Api.md | 3034 ++ .../api-reference/security/_category_.json | 4 + .../api-reference/workloads/AppsApi.md | 62 + .../api-reference/workloads/AppsV1Api.md | 28122 +++++++++++ .../api-reference/workloads/BatchApi.md | 62 + .../api-reference/workloads/BatchV1Api.md | 13489 ++++++ .../api-reference/workloads/_category_.json | 4 + website/versioned_docs/version-2.0.0/intro.md | 81 + .../sdk/attach/classes/Attach.md | 75 + .../version-2.0.0/sdk/attach/index.md | 5 + .../sdk/cache/classes/ListWatch.md | 248 + .../sdk/cache/functions/addOrUpdateObject.md | 33 + .../sdk/cache/functions/cacheMapFromList.md | 21 + .../sdk/cache/functions/deleteItems.md | 29 + .../sdk/cache/functions/deleteObject.md | 29 + .../version-2.0.0/sdk/cache/index.md | 20 + .../sdk/cache/interfaces/ObjectCache.md | 49 + .../sdk/cache/type-aliases/CacheMap.md | 11 + .../sdk/config/classes/KubeConfig.md | 559 + .../functions/bufferFromFileOrString.md | 19 + .../sdk/config/functions/findHomeDir.md | 15 + .../sdk/config/functions/findObject.md | 29 + .../sdk/config/functions/makeAbsolutePath.md | 19 + .../version-2.0.0/sdk/config/index.md | 21 + .../sdk/config/interfaces/ApiType.md | 3 + .../sdk/config/interfaces/Named.md | 11 + .../sdk/config/type-aliases/ApiConstructor.md | 21 + .../config_types/functions/exportCluster.md | 15 + .../config_types/functions/exportContext.md | 15 + .../sdk/config_types/functions/exportUser.md | 15 + .../sdk/config_types/functions/newClusters.md | 19 + .../sdk/config_types/functions/newContexts.md | 19 + .../sdk/config_types/functions/newUsers.md | 19 + .../version-2.0.0/sdk/config_types/index.md | 25 + .../sdk/config_types/interfaces/Cluster.md | 59 + .../config_types/interfaces/ConfigOptions.md | 11 + .../sdk/config_types/interfaces/Context.md | 35 + .../sdk/config_types/interfaces/User.md | 91 + .../type-aliases/ActionOnInvalid.md | 5 + .../config_types/variables/ActionOnInvalid.md | 15 + .../version-2.0.0/sdk/cp/classes/Cp.md | 127 + .../version-2.0.0/sdk/cp/index.md | 5 + .../version-2.0.0/sdk/exec/classes/Exec.md | 103 + .../version-2.0.0/sdk/exec/index.md | 5 + .../sdk/health/classes/Health.md | 65 + .../version-2.0.0/sdk/health/index.md | 5 + .../versioned_docs/version-2.0.0/sdk/index.md | 22 + .../sdk/informer/functions/makeInformer.md | 33 + .../version-2.0.0/sdk/informer/index.md | 31 + .../sdk/informer/interfaces/Informer.md | 121 + .../sdk/informer/type-aliases/ADD.md | 5 + .../sdk/informer/type-aliases/CHANGE.md | 5 + .../sdk/informer/type-aliases/CONNECT.md | 5 + .../sdk/informer/type-aliases/DELETE.md | 5 + .../sdk/informer/type-aliases/ERROR.md | 5 + .../informer/type-aliases/ErrorCallback.md | 15 + .../sdk/informer/type-aliases/ListCallback.md | 25 + .../sdk/informer/type-aliases/ListPromise.md | 15 + .../informer/type-aliases/ObjectCallback.md | 21 + .../sdk/informer/type-aliases/UPDATE.md | 5 + .../sdk/informer/variables/ADD.md | 5 + .../sdk/informer/variables/CHANGE.md | 5 + .../sdk/informer/variables/CONNECT.md | 5 + .../sdk/informer/variables/DELETE.md | 5 + .../sdk/informer/variables/ERROR.md | 5 + .../sdk/informer/variables/UPDATE.md | 5 + .../version-2.0.0/sdk/log/classes/Log.md | 105 + .../log/functions/AddOptionsToSearchParams.md | 19 + .../version-2.0.0/sdk/log/index.md | 13 + .../sdk/log/interfaces/LogOptions.md | 88 + .../sdk/metrics/classes/Metrics.md | 51 + .../version-2.0.0/sdk/metrics/index.md | 14 + .../sdk/metrics/interfaces/ContainerMetric.md | 19 + .../sdk/metrics/interfaces/NodeMetric.md | 47 + .../sdk/metrics/interfaces/NodeMetricsList.md | 39 + .../sdk/metrics/interfaces/PodMetric.md | 51 + .../sdk/metrics/interfaces/PodMetricsList.md | 39 + .../sdk/metrics/interfaces/Usage.md | 19 + .../functions/setHeaderMiddleware.md | 19 + .../middleware/functions/setHeaderOptions.md | 23 + .../version-2.0.0/sdk/middleware/index.md | 6 + .../sdk/object/classes/KubernetesObjectApi.md | 466 + .../version-2.0.0/sdk/object/index.md | 5 + .../version-2.0.0/sdk/patch/index.md | 9 + .../sdk/patch/type-aliases/PatchStrategy.md | 12 + .../sdk/patch/variables/PatchStrategy.md | 38 + .../sdk/portforward/classes/PortForward.md | 195 + .../version-2.0.0/sdk/portforward/index.md | 5 + .../sdk/top/classes/ContainerStatus.md | 53 + .../sdk/top/classes/CurrentResourceUsage.md | 53 + .../sdk/top/classes/NodeStatus.md | 53 + .../sdk/top/classes/PodStatus.md | 65 + .../sdk/top/classes/ResourceUsage.md | 53 + .../sdk/top/functions/topNodes.md | 15 + .../sdk/top/functions/topPods.md | 23 + .../version-2.0.0/sdk/top/index.md | 14 + .../version-2.0.0/sdk/typedoc-sidebar.cjs | 4 + .../sdk/types/classes/V1MicroTime.md | 141 + .../version-2.0.0/sdk/types/index.md | 14 + .../types/interfaces/KubernetesListObject.md | 41 + .../sdk/types/interfaces/KubernetesObject.md | 27 + .../sdk/types/type-aliases/IntOrString.md | 5 + .../version-2.0.0/sdk/watch/classes/Watch.md | 67 + .../version-2.0.0/sdk/watch/index.md | 5 + .../sdk/yaml/functions/dumpYaml.md | 27 + .../sdk/yaml/functions/loadAllYaml.md | 27 + .../sdk/yaml/functions/loadYaml.md | 33 + .../version-2.0.0/sdk/yaml/index.md | 7 + .../version-2.0.0-sidebars.json | 150 + website/versions.json | 3 + 176 files changed, 148060 insertions(+) create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1alpha1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1beta1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1alpha1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/_category_.json create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1alpha2Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1beta1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1beta1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationV1beta1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/_category_.json create mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/_category_.json create mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1beta1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/_category_.json create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ApisApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV2Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/CustomObjectsApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverV1alpha1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/LogsApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/OpenidApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1alpha3Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta2Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/VersionApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/WellKnownApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/_category_.json create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/CertificatesApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1alpha1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1beta1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/_category_.json create mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/AppsApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/AppsV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/BatchApi.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/BatchV1Api.md create mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/_category_.json create mode 100644 website/versioned_docs/version-2.0.0/intro.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/attach/classes/Attach.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/attach/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/classes/ListWatch.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/functions/addOrUpdateObject.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/functions/cacheMapFromList.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteItems.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteObject.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/interfaces/ObjectCache.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/type-aliases/CacheMap.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/classes/KubeConfig.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/functions/bufferFromFileOrString.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/functions/findHomeDir.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/functions/findObject.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/functions/makeAbsolutePath.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/interfaces/ApiType.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/interfaces/Named.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config/type-aliases/ApiConstructor.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportCluster.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportContext.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportUser.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/newClusters.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/newContexts.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/newUsers.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Cluster.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/ConfigOptions.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Context.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/User.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/type-aliases/ActionOnInvalid.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/variables/ActionOnInvalid.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cp/classes/Cp.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/cp/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/exec/classes/Exec.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/exec/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/health/classes/Health.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/health/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/functions/makeInformer.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/interfaces/Informer.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ADD.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CHANGE.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CONNECT.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/DELETE.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ERROR.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ErrorCallback.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListCallback.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListPromise.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ObjectCallback.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/UPDATE.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/ADD.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/CHANGE.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/CONNECT.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/DELETE.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/ERROR.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/UPDATE.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/log/classes/Log.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/log/functions/AddOptionsToSearchParams.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/log/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/log/interfaces/LogOptions.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/classes/Metrics.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/ContainerMetric.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetric.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetricsList.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetric.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetricsList.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/Usage.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderMiddleware.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderOptions.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/middleware/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/object/classes/KubernetesObjectApi.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/object/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/patch/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/patch/type-aliases/PatchStrategy.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/patch/variables/PatchStrategy.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/portforward/classes/PortForward.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/portforward/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/ContainerStatus.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/CurrentResourceUsage.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/NodeStatus.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/PodStatus.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/ResourceUsage.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/top/functions/topNodes.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/top/functions/topPods.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/top/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/typedoc-sidebar.cjs create mode 100644 website/versioned_docs/version-2.0.0/sdk/types/classes/V1MicroTime.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/types/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesListObject.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesObject.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/types/type-aliases/IntOrString.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/watch/classes/Watch.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/watch/index.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/yaml/functions/dumpYaml.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadAllYaml.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadYaml.md create mode 100644 website/versioned_docs/version-2.0.0/sdk/yaml/index.md create mode 100644 website/versioned_sidebars/version-2.0.0-sidebars.json create mode 100644 website/versions.json diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 57ec2885f96..448a6862a4f 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -36,6 +36,17 @@ const config: Config = { docs: { sidebarPath: './sidebars.ts', editUrl: 'https://github.com/kubernetes-client/javascript/tree/main/website/', + lastVersion: 'current', + versions: { + current: { + label: '2.0.0 (Next)', + banner: 'none', + }, + '2.0.0': { + label: '2.0.0', + banner: 'none', + }, + }, }, blog: false, theme: { diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationApi.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationApi.md new file mode 100644 index 00000000000..7b767b754f2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationApi.md @@ -0,0 +1,62 @@ +--- +id: AdmissionregistrationApi +title: AdmissionregistrationApi +sidebar_label: AdmissionregistrationApi +sidebar_position: 1 +--- +# AdmissionregistrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/cluster/AdmissionregistrationApi#getAPIGroup) | **GET** /apis/admissionregistration.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1Api.md new file mode 100644 index 00000000000..998daa88cab --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1Api.md @@ -0,0 +1,3767 @@ +--- +id: AdmissionregistrationV1Api +title: AdmissionregistrationV1Api +sidebar_label: AdmissionregistrationV1Api +sidebar_position: 3 +--- +# AdmissionregistrationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createMutatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**createValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**createValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**createValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**deleteCollectionMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**deleteCollectionValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**deleteCollectionValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**deleteCollectionValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**deleteMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**deleteValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**deleteValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**deleteValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1/ | +[**listMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | +[**listValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | +[**listValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | +[**listValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | +[**patchMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchMutatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**patchValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**patchValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**patchValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicyStatus) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**patchValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**readMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**readValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**readValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**readValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicyStatus) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**readValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | +[**replaceMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceMutatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | +[**replaceValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | +[**replaceValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | +[**replaceValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicyStatus) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | +[**replaceValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | + +### createMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfiguration createMutatingWebhookConfiguration(body) + +create a MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + reinvocationPolicy: "reinvocationPolicy_example", + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1MutatingWebhookConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicy createValidatingAdmissionPolicy(body) + +create a ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBinding createValidatingAdmissionPolicyBinding(body) + +create a ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + validationActions: [ + "validationActions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfiguration createValidatingWebhookConfiguration(body) + +create a ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingWebhookConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingWebhookConfiguration + + + +> V1Status deleteCollectionMutatingWebhookConfiguration() + +delete collection of MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionValidatingAdmissionPolicy + + + +> V1Status deleteCollectionValidatingAdmissionPolicy() + +delete collection of ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionValidatingAdmissionPolicyBinding + + + +> V1Status deleteCollectionValidatingAdmissionPolicyBinding() + +delete collection of ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionValidatingWebhookConfiguration + + + +> V1Status deleteCollectionValidatingWebhookConfiguration() + +delete collection of ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteMutatingWebhookConfiguration + + + +> V1Status deleteMutatingWebhookConfiguration() + +delete a MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteValidatingAdmissionPolicy + + + +> V1Status deleteValidatingAdmissionPolicy() + +delete a ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteValidatingAdmissionPolicyBinding + + + +> V1Status deleteValidatingAdmissionPolicyBinding() + +delete a ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteValidatingWebhookConfiguration + + + +> V1Status deleteValidatingWebhookConfiguration() + +delete a ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfigurationList listMutatingWebhookConfiguration() + +list or watch objects of kind MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfigurationList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicyList listValidatingAdmissionPolicy() + +list or watch objects of kind ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBindingList listValidatingAdmissionPolicyBinding() + +list or watch objects of kind ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfigurationList listValidatingWebhookConfiguration() + +list or watch objects of kind ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfigurationList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfiguration patchMutatingWebhookConfiguration(body) + +partially update the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicy(body) + +partially update the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBinding patchValidatingAdmissionPolicyBinding(body) + +partially update the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchValidatingAdmissionPolicyStatus + + + +> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicyStatus(body) + +partially update status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfiguration patchValidatingWebhookConfiguration(body) + +partially update the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfiguration readMutatingWebhookConfiguration() + +read the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicy() + +read the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBinding readValidatingAdmissionPolicyBinding() + +read the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readValidatingAdmissionPolicyStatus + + + +> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicyStatus() + +read status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfiguration readValidatingWebhookConfiguration() + +read the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceMutatingWebhookConfiguration + + + +> V1MutatingWebhookConfiguration replaceMutatingWebhookConfiguration(body) + +replace the specified MutatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest = { + // name of the MutatingWebhookConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + reinvocationPolicy: "reinvocationPolicy_example", + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1MutatingWebhookConfiguration**| | + **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1MutatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceValidatingAdmissionPolicy + + + +> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicy(body) + +replace the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceValidatingAdmissionPolicyBinding + + + +> V1ValidatingAdmissionPolicyBinding replaceValidatingAdmissionPolicyBinding(body) + +replace the specified ValidatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest = { + // name of the ValidatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + validationActions: [ + "validationActions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceValidatingAdmissionPolicyStatus + + + +> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicyStatus(body) + +replace status of the specified ValidatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest = { + // name of the ValidatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + auditAnnotations: [ + { + key: "key_example", + valueExpression: "valueExpression_example", + }, + ], + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + validations: [ + { + expression: "expression_example", + message: "message_example", + messageExpression: "messageExpression_example", + reason: "reason_example", + }, + ], + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + typeChecking: { + expressionWarnings: [ + { + fieldRef: "fieldRef_example", + warning: "warning_example", + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingAdmissionPolicyStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingAdmissionPolicy**| | + **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceValidatingWebhookConfiguration + + + +> V1ValidatingWebhookConfiguration replaceValidatingWebhookConfiguration(body) + +replace the specified ValidatingWebhookConfiguration + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1Api(configuration); + +const request: AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest = { + // name of the ValidatingWebhookConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + webhooks: [ + { + admissionReviewVersions: [ + "admissionReviewVersions_example", + ], + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchPolicy: "matchPolicy_example", + name: "name_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + sideEffects: "sideEffects_example", + timeoutSeconds: 1, + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceValidatingWebhookConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ValidatingWebhookConfiguration**| | + **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ValidatingWebhookConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1alpha1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1alpha1Api.md new file mode 100644 index 00000000000..353f1bf6d99 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1alpha1Api.md @@ -0,0 +1,1750 @@ +--- +id: AdmissionregistrationV1alpha1Api +title: AdmissionregistrationV1alpha1Api +sidebar_label: AdmissionregistrationV1alpha1Api +sidebar_position: 2 +--- +# AdmissionregistrationV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**createMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**deleteCollectionMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**deleteCollectionMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**deleteMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**deleteMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/ | +[**listMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | +[**listMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | +[**patchMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**patchMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**readMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**readMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | +[**replaceMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | +[**replaceMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | + +### createMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) + +create a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) + +create a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingAdmissionPolicy + + + +> V1Status deleteCollectionMutatingAdmissionPolicy() + +delete collection of MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingAdmissionPolicyBinding + + + +> V1Status deleteCollectionMutatingAdmissionPolicyBinding() + +delete collection of MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteMutatingAdmissionPolicy + + + +> V1Status deleteMutatingAdmissionPolicy() + +delete a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteMutatingAdmissionPolicyBinding + + + +> V1Status deleteMutatingAdmissionPolicyBinding() + +delete a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() + +list or watch objects of kind MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() + +list or watch objects of kind MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) + +partially update the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) + +partially update the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicy readMutatingAdmissionPolicy() + +read the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() + +read the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceMutatingAdmissionPolicy + + + +> V1alpha1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) + +replace the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicy**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceMutatingAdmissionPolicyBinding + + + +> V1alpha1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) + +replace the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); + +const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1beta1Api.md new file mode 100644 index 00000000000..e27b1f8e351 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1beta1Api.md @@ -0,0 +1,1750 @@ +--- +id: AdmissionregistrationV1beta1Api +title: AdmissionregistrationV1beta1Api +sidebar_label: AdmissionregistrationV1beta1Api +sidebar_position: 4 +--- +# AdmissionregistrationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**createMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**deleteCollectionMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**deleteCollectionMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**deleteMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**deleteMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1beta1/ | +[**listMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | +[**listMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | +[**patchMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**patchMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**readMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**readMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | +[**replaceMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | +[**replaceMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | + +### createMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) + +create a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicy**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) + +create a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicyBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingAdmissionPolicy + + + +> V1Status deleteCollectionMutatingAdmissionPolicy() + +delete collection of MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionMutatingAdmissionPolicyBinding + + + +> V1Status deleteCollectionMutatingAdmissionPolicyBinding() + +delete collection of MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteMutatingAdmissionPolicy + + + +> V1Status deleteMutatingAdmissionPolicy() + +delete a MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteMutatingAdmissionPolicyBinding + + + +> V1Status deleteMutatingAdmissionPolicyBinding() + +delete a MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() + +list or watch objects of kind MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() + +list or watch objects of kind MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) + +partially update the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) + +partially update the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicy readMutatingAdmissionPolicy() + +read the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() + +read the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceMutatingAdmissionPolicy + + + +> V1beta1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) + +replace the specified MutatingAdmissionPolicy + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest = { + // name of the MutatingAdmissionPolicy + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + failurePolicy: "failurePolicy_example", + matchConditions: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + matchConstraints: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + mutations: [ + { + applyConfiguration: { + expression: "expression_example", + }, + jsonPatch: { + expression: "expression_example", + }, + patchType: "patchType_example", + }, + ], + paramKind: { + apiVersion: "apiVersion_example", + kind: "kind_example", + }, + reinvocationPolicy: "reinvocationPolicy_example", + variables: [ + { + expression: "expression_example", + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicy**| | + **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceMutatingAdmissionPolicyBinding + + + +> V1beta1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) + +replace the specified MutatingAdmissionPolicyBinding + +### Example + + +```typescript +import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; +import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AdmissionregistrationV1beta1Api(configuration); + +const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest = { + // name of the MutatingAdmissionPolicyBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + matchResources: { + excludeResourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + matchPolicy: "matchPolicy_example", + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + objectSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + apiVersions: [ + "apiVersions_example", + ], + operations: [ + "operations_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + scope: "scope_example", + }, + ], + }, + paramRef: { + name: "name_example", + namespace: "namespace_example", + parameterNotFoundAction: "parameterNotFoundAction_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + policyName: "policyName_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1MutatingAdmissionPolicyBinding**| | + **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1MutatingAdmissionPolicyBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsApi.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsApi.md new file mode 100644 index 00000000000..ea5d8022ad9 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsApi.md @@ -0,0 +1,62 @@ +--- +id: ApiextensionsApi +title: ApiextensionsApi +sidebar_label: ApiextensionsApi +sidebar_position: 5 +--- +# ApiextensionsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/cluster/ApiextensionsApi#getAPIGroup) | **GET** /apis/apiextensions.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ApiextensionsApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsV1Api.md new file mode 100644 index 00000000000..bd87829b480 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsV1Api.md @@ -0,0 +1,1484 @@ +--- +id: ApiextensionsV1Api +title: ApiextensionsV1Api +sidebar_label: ApiextensionsV1Api +sidebar_position: 6 +--- +# ApiextensionsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#createCustomResourceDefinition) | **POST** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**deleteCollectionCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#deleteCollectionCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**deleteCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#deleteCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**getAPIResources**](/docs/api-reference/cluster/ApiextensionsV1Api#getAPIResources) | **GET** /apis/apiextensions.k8s.io/v1/ | +[**listCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#listCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | +[**patchCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#patchCustomResourceDefinition) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**patchCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#patchCustomResourceDefinitionStatus) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | +[**readCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#readCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**readCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#readCustomResourceDefinitionStatus) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | +[**replaceCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#replaceCustomResourceDefinition) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | +[**replaceCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#replaceCustomResourceDefinitionStatus) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | + +### createCustomResourceDefinition + + + +> V1CustomResourceDefinition createCustomResourceDefinition(body) + +create a CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiCreateCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiCreateCustomResourceDefinitionRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionCustomResourceDefinition + + + +> V1Status deleteCollectionCustomResourceDefinition() + +delete collection of CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCustomResourceDefinition + + + +> V1Status deleteCustomResourceDefinition() + +delete a CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCustomResourceDefinition + + + +> V1CustomResourceDefinitionList listCustomResourceDefinition() + +list or watch objects of kind CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiListCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiListCustomResourceDefinitionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinitionList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchCustomResourceDefinition + + + +> V1CustomResourceDefinition patchCustomResourceDefinition(body) + +partially update the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiPatchCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiPatchCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchCustomResourceDefinitionStatus + + + +> V1CustomResourceDefinition patchCustomResourceDefinitionStatus(body) + +partially update status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readCustomResourceDefinition + + + +> V1CustomResourceDefinition readCustomResourceDefinition() + +read the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiReadCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReadCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readCustomResourceDefinitionStatus + + + +> V1CustomResourceDefinition readCustomResourceDefinitionStatus() + +read status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceCustomResourceDefinition + + + +> V1CustomResourceDefinition replaceCustomResourceDefinition(body) + +replace the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCustomResourceDefinition(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceCustomResourceDefinitionStatus + + + +> V1CustomResourceDefinition replaceCustomResourceDefinitionStatus(body) + +replace status of the specified CustomResourceDefinition + +### Example + + +```typescript +import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; +import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiextensionsV1Api(configuration); + +const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest = { + // name of the CustomResourceDefinition + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + conversion: { + strategy: "strategy_example", + webhook: { + clientConfig: { + caBundle: 'YQ==', + service: { + name: "name_example", + namespace: "namespace_example", + path: "path_example", + port: 1, + }, + url: "url_example", + }, + conversionReviewVersions: [ + "conversionReviewVersions_example", + ], + }, + }, + group: "group_example", + names: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + preserveUnknownFields: true, + scope: "scope_example", + versions: [ + { + additionalPrinterColumns: [ + { + description: "description_example", + format: "format_example", + jsonPath: "jsonPath_example", + name: "name_example", + priority: 1, + type: "type_example", + }, + ], + deprecated: true, + deprecationWarning: "deprecationWarning_example", + name: "name_example", + schema: { + openAPIV3Schema: { + ref: "ref_example", + schema: "schema_example", + additionalItems: {}, + additionalProperties: {}, + allOf: [ + , + ], + anyOf: [ + , + ], + _default: {}, + definitions: { + "key": , + }, + dependencies: { + "key": {}, + }, + description: "description_example", + _enum: [ + {}, + ], + example: {}, + exclusiveMaximum: true, + exclusiveMinimum: true, + externalDocs: { + description: "description_example", + url: "url_example", + }, + format: "format_example", + id: "id_example", + items: {}, + maxItems: 1, + maxLength: 1, + maxProperties: 1, + maximum: 3.14, + minItems: 1, + minLength: 1, + minProperties: 1, + minimum: 3.14, + multipleOf: 3.14, + not: , + nullable: true, + oneOf: [ + , + ], + pattern: "pattern_example", + patternProperties: { + "key": , + }, + properties: { + "key": , + }, + required: [ + "required_example", + ], + title: "title_example", + type: "type_example", + uniqueItems: true, + x_kubernetes_embedded_resource: true, + x_kubernetes_int_or_string: true, + x_kubernetes_list_map_keys: [ + "x_kubernetes_list_map_keys_example", + ], + x_kubernetes_list_type: "x_kubernetes_list_type_example", + x_kubernetes_map_type: "x_kubernetes_map_type_example", + x_kubernetes_preserve_unknown_fields: true, + x_kubernetes_validations: [ + { + fieldPath: "fieldPath_example", + message: "message_example", + messageExpression: "messageExpression_example", + optionalOldSelf: true, + reason: "reason_example", + rule: "rule_example", + }, + ], + }, + }, + selectableFields: [ + { + jsonPath: "jsonPath_example", + }, + ], + served: true, + storage: true, + subresources: { + scale: { + labelSelectorPath: "labelSelectorPath_example", + specReplicasPath: "specReplicasPath_example", + statusReplicasPath: "statusReplicasPath_example", + }, + status: {}, + }, + }, + ], + }, + status: { + acceptedNames: { + categories: [ + "categories_example", + ], + kind: "kind_example", + listKind: "listKind_example", + plural: "plural_example", + shortNames: [ + "shortNames_example", + ], + singular: "singular_example", + }, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + storedVersions: [ + "storedVersions_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCustomResourceDefinitionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CustomResourceDefinition**| | + **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CustomResourceDefinition + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationApi.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationApi.md new file mode 100644 index 00000000000..d129ebb0855 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationApi.md @@ -0,0 +1,62 @@ +--- +id: ApiregistrationApi +title: ApiregistrationApi +sidebar_label: ApiregistrationApi +sidebar_position: 7 +--- +# ApiregistrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/cluster/ApiregistrationApi#getAPIGroup) | **GET** /apis/apiregistration.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ApiregistrationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationV1Api.md new file mode 100644 index 00000000000..962919a679a --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationV1Api.md @@ -0,0 +1,1031 @@ +--- +id: ApiregistrationV1Api +title: ApiregistrationV1Api +sidebar_label: ApiregistrationV1Api +sidebar_position: 8 +--- +# ApiregistrationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#createAPIService) | **POST** /apis/apiregistration.k8s.io/v1/apiservices | +[**deleteAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#deleteAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**deleteCollectionAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#deleteCollectionAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices | +[**getAPIResources**](/docs/api-reference/cluster/ApiregistrationV1Api#getAPIResources) | **GET** /apis/apiregistration.k8s.io/v1/ | +[**listAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#listAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices | +[**patchAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#patchAPIService) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**patchAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#patchAPIServiceStatus) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | +[**readAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#readAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**readAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#readAPIServiceStatus) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | +[**replaceAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#replaceAPIService) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name} | +[**replaceAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#replaceAPIServiceStatus) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | + +### createAPIService + + + +> V1APIService createAPIService(body) + +create an APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiCreateAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiCreateAPIServiceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteAPIService + + + +> V1Status deleteAPIService() + +delete an APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiDeleteAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiDeleteAPIServiceRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionAPIService + + + +> V1Status deleteCollectionAPIService() + +delete collection of APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiDeleteCollectionAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiDeleteCollectionAPIServiceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listAPIService + + + +> V1APIServiceList listAPIService() + +list or watch objects of kind APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiListAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiListAPIServiceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1APIServiceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchAPIService + + + +> V1APIService patchAPIService(body) + +partially update the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiPatchAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiPatchAPIServiceRequest = { + // name of the APIService + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchAPIServiceStatus + + + +> V1APIService patchAPIServiceStatus(body) + +partially update status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiPatchAPIServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiPatchAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readAPIService + + + +> V1APIService readAPIService() + +read the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiReadAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReadAPIServiceRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readAPIServiceStatus + + + +> V1APIService readAPIServiceStatus() + +read status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiReadAPIServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReadAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceAPIService + + + +> V1APIService replaceAPIService(body) + +replace the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiReplaceAPIServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReplaceAPIServiceRequest = { + // name of the APIService + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceAPIService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceAPIServiceStatus + + + +> V1APIService replaceAPIServiceStatus(body) + +replace status of the specified APIService + +### Example + + +```typescript +import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; +import type { ApiregistrationV1ApiReplaceAPIServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApiregistrationV1Api(configuration); + +const request: ApiregistrationV1ApiReplaceAPIServiceStatusRequest = { + // name of the APIService + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + caBundle: 'YQ==', + group: "group_example", + groupPriorityMinimum: 1, + insecureSkipTLSVerify: true, + service: { + name: "name_example", + namespace: "namespace_example", + port: 1, + }, + version: "version_example", + versionPriority: 1, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceAPIServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1APIService**| | + **name** | [**string**] | name of the APIService | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1APIService + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingApi.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingApi.md new file mode 100644 index 00000000000..574a8c7d9b8 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingApi.md @@ -0,0 +1,62 @@ +--- +id: SchedulingApi +title: SchedulingApi +sidebar_label: SchedulingApi +sidebar_position: 9 +--- +# SchedulingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/cluster/SchedulingApi#getAPIGroup) | **GET** /apis/scheduling.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, SchedulingApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1Api.md new file mode 100644 index 00000000000..2bb8614b6f4 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1Api.md @@ -0,0 +1,719 @@ +--- +id: SchedulingV1Api +title: SchedulingV1Api +sidebar_label: SchedulingV1Api +sidebar_position: 11 +--- +# SchedulingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#createPriorityClass) | **POST** /apis/scheduling.k8s.io/v1/priorityclasses | +[**deleteCollectionPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#deleteCollectionPriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses | +[**deletePriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#deletePriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**getAPIResources**](/docs/api-reference/cluster/SchedulingV1Api#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1/ | +[**listPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#listPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses | +[**patchPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#patchPriorityClass) | **PATCH** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**readPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#readPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | +[**replacePriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#replacePriorityClass) | **PUT** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | + +### createPriorityClass + + + +> V1PriorityClass createPriorityClass(body) + +create a PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiCreatePriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiCreatePriorityClassRequest = { + + body: { + apiVersion: "apiVersion_example", + description: "description_example", + globalDefault: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + preemptionPolicy: "preemptionPolicy_example", + value: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionPriorityClass + + + +> V1Status deleteCollectionPriorityClass() + +delete collection of PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiDeleteCollectionPriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiDeleteCollectionPriorityClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deletePriorityClass + + + +> V1Status deletePriorityClass() + +delete a PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiDeletePriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiDeletePriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPriorityClass + + + +> V1PriorityClassList listPriorityClass() + +list or watch objects of kind PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiListPriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiListPriorityClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PriorityClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchPriorityClass + + + +> V1PriorityClass patchPriorityClass(body) + +partially update the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiPatchPriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiPatchPriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PriorityClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readPriorityClass + + + +> V1PriorityClass readPriorityClass() + +read the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiReadPriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiReadPriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PriorityClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replacePriorityClass + + + +> V1PriorityClass replacePriorityClass(body) + +replace the specified PriorityClass + +### Example + + +```typescript +import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; +import type { SchedulingV1ApiReplacePriorityClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1Api(configuration); + +const request: SchedulingV1ApiReplacePriorityClassRequest = { + // name of the PriorityClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + description: "description_example", + globalDefault: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + preemptionPolicy: "preemptionPolicy_example", + value: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityClass**| | + **name** | [**string**] | name of the PriorityClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1alpha1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1alpha1Api.md new file mode 100644 index 00000000000..73e5bfc18f5 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1alpha1Api.md @@ -0,0 +1,853 @@ +--- +id: SchedulingV1alpha1Api +title: SchedulingV1alpha1Api +sidebar_label: SchedulingV1alpha1Api +sidebar_position: 10 +--- +# SchedulingV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#createNamespacedWorkload) | **POST** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**deleteCollectionNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#deleteCollectionNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**deleteNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#deleteNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**getAPIResources**](/docs/api-reference/cluster/SchedulingV1alpha1Api#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1alpha1/ | +[**listNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#listNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | +[**listWorkloadForAllNamespaces**](/docs/api-reference/cluster/SchedulingV1alpha1Api#listWorkloadForAllNamespaces) | **GET** /apis/scheduling.k8s.io/v1alpha1/workloads | +[**patchNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#patchNamespacedWorkload) | **PATCH** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**readNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#readNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | +[**replaceNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#replaceNamespacedWorkload) | **PUT** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | + +### createNamespacedWorkload + + + +> V1alpha1Workload createNamespacedWorkload(body) + +create a Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controllerRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + podGroups: [ + { + name: "name_example", + policy: { + basic: {}, + gang: { + minCount: 1, + }, + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1Workload**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1Workload + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedWorkload + + + +> V1Status deleteCollectionNamespacedWorkload() + +delete collection of Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedWorkload + + + +> V1Status deleteNamespacedWorkload() + +delete a Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedWorkload + + + +> V1alpha1WorkloadList listNamespacedWorkload() + +list or watch objects of kind Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiListNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiListNamespacedWorkloadRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1WorkloadList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listWorkloadForAllNamespaces + + + +> V1alpha1WorkloadList listWorkloadForAllNamespaces() + +list or watch objects of kind Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listWorkloadForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1WorkloadList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedWorkload + + + +> V1alpha1Workload patchNamespacedWorkload(body) + +partially update the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1Workload + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedWorkload + + + +> V1alpha1Workload readNamespacedWorkload() + +read the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiReadNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiReadNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1Workload + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedWorkload + + + +> V1alpha1Workload replaceNamespacedWorkload(body) + +replace the specified Workload + +### Example + + +```typescript +import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; +import type { SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new SchedulingV1alpha1Api(configuration); + +const request: SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest = { + // name of the Workload + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controllerRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + podGroups: [ + { + name: "name_example", + policy: { + basic: {}, + gang: { + minCount: 1, + }, + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedWorkload(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1Workload**| | + **name** | [**string**] | name of the Workload | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1Workload + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/cluster/_category_.json new file mode 100644 index 00000000000..0cc46b9cf1e --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/cluster/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Cluster", + "position": 6 +} diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationApi.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationApi.md new file mode 100644 index 00000000000..80b8df4938e --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationApi.md @@ -0,0 +1,62 @@ +--- +id: CoordinationApi +title: CoordinationApi +sidebar_label: CoordinationApi +sidebar_position: 1 +--- +# CoordinationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/configuration-storage/CoordinationApi#getAPIGroup) | **GET** /apis/coordination.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, CoordinationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1Api.md new file mode 100644 index 00000000000..9473e68ac7a --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1Api.md @@ -0,0 +1,835 @@ +--- +id: CoordinationV1Api +title: CoordinationV1Api +sidebar_label: CoordinationV1Api +sidebar_position: 3 +--- +# CoordinationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#createNamespacedLease) | **POST** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**deleteCollectionNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#deleteCollectionNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**deleteNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#deleteNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1/ | +[**listLeaseForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1Api#listLeaseForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1/leases | +[**listNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#listNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | +[**patchNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#patchNamespacedLease) | **PATCH** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**readNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#readNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | +[**replaceNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#replaceNamespacedLease) | **PUT** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | + +### createNamespacedLease + + + +> V1Lease createNamespacedLease(body) + +create a Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiCreateNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiCreateNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + acquireTime: "acquireTime_example", + holderIdentity: "holderIdentity_example", + leaseDurationSeconds: 1, + leaseTransitions: 1, + preferredHolder: "preferredHolder_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Lease**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Lease + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedLease + + + +> V1Status deleteCollectionNamespacedLease() + +delete collection of Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedLease + + + +> V1Status deleteNamespacedLease() + +delete a Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiDeleteNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiDeleteNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listLeaseForAllNamespaces + + + +> V1LeaseList listLeaseForAllNamespaces() + +list or watch objects of kind Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiListLeaseForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiListLeaseForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1LeaseList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedLease + + + +> V1LeaseList listNamespacedLease() + +list or watch objects of kind Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiListNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiListNamespacedLeaseRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1LeaseList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedLease + + + +> V1Lease patchNamespacedLease(body) + +partially update the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiPatchNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiPatchNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Lease + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedLease + + + +> V1Lease readNamespacedLease() + +read the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiReadNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiReadNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Lease + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedLease + + + +> V1Lease replaceNamespacedLease(body) + +replace the specified Lease + +### Example + + +```typescript +import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; +import type { CoordinationV1ApiReplaceNamespacedLeaseRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1Api(configuration); + +const request: CoordinationV1ApiReplaceNamespacedLeaseRequest = { + // name of the Lease + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + acquireTime: "acquireTime_example", + holderIdentity: "holderIdentity_example", + leaseDurationSeconds: 1, + leaseTransitions: 1, + preferredHolder: "preferredHolder_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLease(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Lease**| | + **name** | [**string**] | name of the Lease | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Lease + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1alpha2Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1alpha2Api.md new file mode 100644 index 00000000000..28670d08afe --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1alpha2Api.md @@ -0,0 +1,833 @@ +--- +id: CoordinationV1alpha2Api +title: CoordinationV1alpha2Api +sidebar_label: CoordinationV1alpha2Api +sidebar_position: 2 +--- +# CoordinationV1alpha2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**deleteCollectionNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**deleteNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1alpha2/ | +[**listLeaseCandidateForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1alpha2/leasecandidates | +[**listNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | +[**patchNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**readNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | +[**replaceNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | + +### createNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidate createNamespacedLeaseCandidate(body) + +create a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha2LeaseCandidate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedLeaseCandidate + + + +> V1Status deleteCollectionNamespacedLeaseCandidate() + +delete collection of LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedLeaseCandidate + + + +> V1Status deleteNamespacedLeaseCandidate() + +delete a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listLeaseCandidateForAllNamespaces + + + +> V1alpha2LeaseCandidateList listLeaseCandidateForAllNamespaces() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidateList listNamespacedLeaseCandidate() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidate patchNamespacedLeaseCandidate(body) + +partially update the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidate readNamespacedLeaseCandidate() + +read the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedLeaseCandidate + + + +> V1alpha2LeaseCandidate replaceNamespacedLeaseCandidate(body) + +replace the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; +import type { CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1alpha2Api(configuration); + +const request: CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha2LeaseCandidate**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha2LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1beta1Api.md new file mode 100644 index 00000000000..ae939c61b48 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1beta1Api.md @@ -0,0 +1,833 @@ +--- +id: CoordinationV1beta1Api +title: CoordinationV1beta1Api +sidebar_label: CoordinationV1beta1Api +sidebar_position: 4 +--- +# CoordinationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**deleteCollectionNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**deleteNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1beta1/ | +[**listLeaseCandidateForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1beta1/leasecandidates | +[**listNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | +[**patchNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**readNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | +[**replaceNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | + +### createNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidate createNamespacedLeaseCandidate(body) + +create a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1LeaseCandidate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedLeaseCandidate + + + +> V1Status deleteCollectionNamespacedLeaseCandidate() + +delete collection of LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedLeaseCandidate + + + +> V1Status deleteNamespacedLeaseCandidate() + +delete a LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listLeaseCandidateForAllNamespaces + + + +> V1beta1LeaseCandidateList listLeaseCandidateForAllNamespaces() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidateList listNamespacedLeaseCandidate() + +list or watch objects of kind LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidate patchNamespacedLeaseCandidate(body) + +partially update the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidate readNamespacedLeaseCandidate() + +read the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedLeaseCandidate + + + +> V1beta1LeaseCandidate replaceNamespacedLeaseCandidate(body) + +replace the specified LeaseCandidate + +### Example + + +```typescript +import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; +import type { CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoordinationV1beta1Api(configuration); + +const request: CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest = { + // name of the LeaseCandidate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + binaryVersion: "binaryVersion_example", + emulationVersion: "emulationVersion_example", + leaseName: "leaseName_example", + pingTime: "pingTime_example", + renewTime: "renewTime_example", + strategy: "strategy_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLeaseCandidate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1LeaseCandidate**| | + **name** | [**string**] | name of the LeaseCandidate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1LeaseCandidate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyApi.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyApi.md new file mode 100644 index 00000000000..3dc65d31ce0 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyApi.md @@ -0,0 +1,62 @@ +--- +id: PolicyApi +title: PolicyApi +sidebar_label: PolicyApi +sidebar_position: 5 +--- +# PolicyApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/configuration-storage/PolicyApi#getAPIGroup) | **GET** /apis/policy/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, PolicyApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyV1Api.md new file mode 100644 index 00000000000..57e052b9fb7 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyV1Api.md @@ -0,0 +1,1191 @@ +--- +id: PolicyV1Api +title: PolicyV1Api +sidebar_label: PolicyV1Api +sidebar_position: 6 +--- +# PolicyV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#createNamespacedPodDisruptionBudget) | **POST** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**deleteCollectionNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#deleteCollectionNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**deleteNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#deleteNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/PolicyV1Api#getAPIResources) | **GET** /apis/policy/v1/ | +[**listNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#listNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | +[**listPodDisruptionBudgetForAllNamespaces**](/docs/api-reference/configuration-storage/PolicyV1Api#listPodDisruptionBudgetForAllNamespaces) | **GET** /apis/policy/v1/poddisruptionbudgets | +[**patchNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#patchNamespacedPodDisruptionBudget) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**patchNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#patchNamespacedPodDisruptionBudgetStatus) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | +[**readNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#readNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**readNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#readNamespacedPodDisruptionBudgetStatus) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | +[**replaceNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#replaceNamespacedPodDisruptionBudget) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | +[**replaceNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#replaceNamespacedPodDisruptionBudgetStatus) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | + +### createNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudget createNamespacedPodDisruptionBudget(body) + +create a PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPodDisruptionBudget + + + +> V1Status deleteCollectionNamespacedPodDisruptionBudget() + +delete collection of PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedPodDisruptionBudget + + + +> V1Status deleteNamespacedPodDisruptionBudget() + +delete a PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudgetList listNamespacedPodDisruptionBudget() + +list or watch objects of kind PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiListNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiListNamespacedPodDisruptionBudgetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudgetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPodDisruptionBudgetForAllNamespaces + + + +> V1PodDisruptionBudgetList listPodDisruptionBudgetForAllNamespaces() + +list or watch objects of kind PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodDisruptionBudgetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudgetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudget patchNamespacedPodDisruptionBudget(body) + +partially update the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodDisruptionBudgetStatus + + + +> V1PodDisruptionBudget patchNamespacedPodDisruptionBudgetStatus(body) + +partially update status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudget readNamespacedPodDisruptionBudget() + +read the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodDisruptionBudgetStatus + + + +> V1PodDisruptionBudget readNamespacedPodDisruptionBudgetStatus() + +read status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodDisruptionBudget + + + +> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudget(body) + +replace the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodDisruptionBudget(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodDisruptionBudgetStatus + + + +> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudgetStatus(body) + +replace status of the specified PodDisruptionBudget + +### Example + + +```typescript +import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; +import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new PolicyV1Api(configuration); + +const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest = { + // name of the PodDisruptionBudget + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxUnavailable: "maxUnavailable_example", + minAvailable: "minAvailable_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentHealthy: 1, + desiredHealthy: 1, + disruptedPods: { + "key": new Date('1970-01-01T00:00:00.00Z'), + }, + disruptionsAllowed: 1, + expectedPods: 1, + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodDisruptionBudgetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodDisruptionBudget**| | + **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodDisruptionBudget + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageApi.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageApi.md new file mode 100644 index 00000000000..e5460e8bc7e --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageApi.md @@ -0,0 +1,62 @@ +--- +id: StorageApi +title: StorageApi +sidebar_label: StorageApi +sidebar_position: 7 +--- +# StorageApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/configuration-storage/StorageApi#getAPIGroup) | **GET** /apis/storage.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, StorageApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1Api.md new file mode 100644 index 00000000000..5a7b8715d3c --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1Api.md @@ -0,0 +1,5308 @@ +--- +id: StorageV1Api +title: StorageV1Api +sidebar_label: StorageV1Api +sidebar_position: 10 +--- +# StorageV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#createCSIDriver) | **POST** /apis/storage.k8s.io/v1/csidrivers | +[**createCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#createCSINode) | **POST** /apis/storage.k8s.io/v1/csinodes | +[**createNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#createNamespacedCSIStorageCapacity) | **POST** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**createStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#createStorageClass) | **POST** /apis/storage.k8s.io/v1/storageclasses | +[**createVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#createVolumeAttachment) | **POST** /apis/storage.k8s.io/v1/volumeattachments | +[**createVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**deleteCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**deleteCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes/{name} | +[**deleteCollectionCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers | +[**deleteCollectionCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes | +[**deleteCollectionNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**deleteCollectionStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses | +[**deleteCollectionVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments | +[**deleteCollectionVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**deleteNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#deleteNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**deleteStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**deleteVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#deleteVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**deleteVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/StorageV1Api#getAPIResources) | **GET** /apis/storage.k8s.io/v1/ | +[**listCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#listCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers | +[**listCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#listCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes | +[**listCSIStorageCapacityForAllNamespaces**](/docs/api-reference/configuration-storage/StorageV1Api#listCSIStorageCapacityForAllNamespaces) | **GET** /apis/storage.k8s.io/v1/csistoragecapacities | +[**listNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#listNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | +[**listStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#listStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses | +[**listVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#listVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments | +[**listVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses | +[**patchCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#patchCSIDriver) | **PATCH** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**patchCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#patchCSINode) | **PATCH** /apis/storage.k8s.io/v1/csinodes/{name} | +[**patchNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#patchNamespacedCSIStorageCapacity) | **PATCH** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**patchStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#patchStorageClass) | **PATCH** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**patchVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttachment) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**patchVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttachmentStatus) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**patchVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**readCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#readCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**readCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#readCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes/{name} | +[**readNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#readNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**readStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#readStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**readVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**readVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttachmentStatus) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**readVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | +[**replaceCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#replaceCSIDriver) | **PUT** /apis/storage.k8s.io/v1/csidrivers/{name} | +[**replaceCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#replaceCSINode) | **PUT** /apis/storage.k8s.io/v1/csinodes/{name} | +[**replaceNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#replaceNamespacedCSIStorageCapacity) | **PUT** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | +[**replaceStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#replaceStorageClass) | **PUT** /apis/storage.k8s.io/v1/storageclasses/{name} | +[**replaceVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttachment) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name} | +[**replaceVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttachmentStatus) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | +[**replaceVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | + +### createCSIDriver + + + +> V1CSIDriver createCSIDriver(body) + +create a CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateCSIDriverRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attachRequired: true, + fsGroupPolicy: "fsGroupPolicy_example", + nodeAllocatableUpdatePeriodSeconds: 1, + podInfoOnMount: true, + requiresRepublish: true, + seLinuxMount: true, + serviceAccountTokenInSecrets: true, + storageCapacity: true, + tokenRequests: [ + { + audience: "audience_example", + expirationSeconds: 1, + }, + ], + volumeLifecycleModes: [ + "volumeLifecycleModes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIDriver**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createCSINode + + + +> V1CSINode createCSINode(body) + +create a CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateCSINodeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + drivers: [ + { + allocatable: { + count: 1, + }, + name: "name_example", + nodeID: "nodeID_example", + topologyKeys: [ + "topologyKeys_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSINode**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacity createNamespacedCSIStorageCapacity(body) + +create a CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + capacity: "capacity_example", + kind: "kind_example", + maximumVolumeSize: "maximumVolumeSize_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + nodeTopology: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIStorageCapacity**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacity + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createStorageClass + + + +> V1StorageClass createStorageClass(body) + +create a StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateStorageClassRequest = { + + body: { + allowVolumeExpansion: true, + allowedTopologies: [ + { + matchLabelExpressions: [ + { + key: "key_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + mountOptions: [ + "mountOptions_example", + ], + parameters: { + "key": "key_example", + }, + provisioner: "provisioner_example", + reclaimPolicy: "reclaimPolicy_example", + volumeBindingMode: "volumeBindingMode_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StorageClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createVolumeAttachment + + + +> V1VolumeAttachment createVolumeAttachment(body) + +create a VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateVolumeAttachmentRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createVolumeAttributesClass + + + +> V1VolumeAttributesClass createVolumeAttributesClass(body) + +create a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiCreateVolumeAttributesClassRequest = { + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttributesClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCSIDriver + + + +> V1CSIDriver deleteCSIDriver() + +delete a CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCSINode + + + +> V1CSINode deleteCSINode() + +delete a CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCSINodeRequest = { + // name of the CSINode + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionCSIDriver + + + +> V1Status deleteCollectionCSIDriver() + +delete collection of CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionCSIDriverRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionCSINode + + + +> V1Status deleteCollectionCSINode() + +delete collection of CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionCSINodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedCSIStorageCapacity + + + +> V1Status deleteCollectionNamespacedCSIStorageCapacity() + +delete collection of CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionStorageClass + + + +> V1Status deleteCollectionStorageClass() + +delete collection of StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionStorageClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionVolumeAttachment + + + +> V1Status deleteCollectionVolumeAttachment() + +delete collection of VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionVolumeAttachmentRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionVolumeAttributesClass + + + +> V1Status deleteCollectionVolumeAttributesClass() + +delete collection of VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteCollectionVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedCSIStorageCapacity + + + +> V1Status deleteNamespacedCSIStorageCapacity() + +delete a CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteStorageClass + + + +> V1StorageClass deleteStorageClass() + +delete a StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteStorageClassRequest = { + // name of the StorageClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteVolumeAttachment + + + +> V1VolumeAttachment deleteVolumeAttachment() + +delete a VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteVolumeAttributesClass + + + +> V1VolumeAttributesClass deleteVolumeAttributesClass() + +delete a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiDeleteVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCSIDriver + + + +> V1CSIDriverList listCSIDriver() + +list or watch objects of kind CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSIDriverRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CSIDriverList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCSINode + + + +> V1CSINodeList listCSINode() + +list or watch objects of kind CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSINodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CSINodeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCSIStorageCapacityForAllNamespaces + + + +> V1CSIStorageCapacityList listCSIStorageCapacityForAllNamespaces() + +list or watch objects of kind CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCSIStorageCapacityForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacityList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacityList listNamespacedCSIStorageCapacity() + +list or watch objects of kind CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListNamespacedCSIStorageCapacityRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacityList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listStorageClass + + + +> V1StorageClassList listStorageClass() + +list or watch objects of kind StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListStorageClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1StorageClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listVolumeAttachment + + + +> V1VolumeAttachmentList listVolumeAttachment() + +list or watch objects of kind VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListVolumeAttachmentRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachmentList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listVolumeAttributesClass + + + +> V1VolumeAttributesClassList listVolumeAttributesClass() + +list or watch objects of kind VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiListVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchCSIDriver + + + +> V1CSIDriver patchCSIDriver(body) + +partially update the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchCSINode + + + +> V1CSINode patchCSINode(body) + +partially update the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchCSINodeRequest = { + // name of the CSINode + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacity patchNamespacedCSIStorageCapacity(body) + +partially update the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacity + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchStorageClass + + + +> V1StorageClass patchStorageClass(body) + +partially update the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchStorageClassRequest = { + // name of the StorageClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchVolumeAttachment + + + +> V1VolumeAttachment patchVolumeAttachment(body) + +partially update the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchVolumeAttachmentStatus + + + +> V1VolumeAttachment patchVolumeAttachmentStatus(body) + +partially update status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchVolumeAttributesClass + + + +> V1VolumeAttributesClass patchVolumeAttributesClass(body) + +partially update the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiPatchVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readCSIDriver + + + +> V1CSIDriver readCSIDriver() + +read the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readCSINode + + + +> V1CSINode readCSINode() + +read the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadCSINodeRequest = { + // name of the CSINode + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacity readNamespacedCSIStorageCapacity() + +read the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacity + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readStorageClass + + + +> V1StorageClass readStorageClass() + +read the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadStorageClassRequest = { + // name of the StorageClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readVolumeAttachment + + + +> V1VolumeAttachment readVolumeAttachment() + +read the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readVolumeAttachmentStatus + + + +> V1VolumeAttachment readVolumeAttachmentStatus() + +read status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readVolumeAttributesClass + + + +> V1VolumeAttributesClass readVolumeAttributesClass() + +read the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReadVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceCSIDriver + + + +> V1CSIDriver replaceCSIDriver(body) + +replace the specified CSIDriver + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceCSIDriverRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceCSIDriverRequest = { + // name of the CSIDriver + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attachRequired: true, + fsGroupPolicy: "fsGroupPolicy_example", + nodeAllocatableUpdatePeriodSeconds: 1, + podInfoOnMount: true, + requiresRepublish: true, + seLinuxMount: true, + serviceAccountTokenInSecrets: true, + storageCapacity: true, + tokenRequests: [ + { + audience: "audience_example", + expirationSeconds: 1, + }, + ], + volumeLifecycleModes: [ + "volumeLifecycleModes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCSIDriver(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIDriver**| | + **name** | [**string**] | name of the CSIDriver | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSIDriver + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceCSINode + + + +> V1CSINode replaceCSINode(body) + +replace the specified CSINode + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceCSINodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceCSINodeRequest = { + // name of the CSINode + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + drivers: [ + { + allocatable: { + count: 1, + }, + name: "name_example", + nodeID: "nodeID_example", + topologyKeys: [ + "topologyKeys_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCSINode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSINode**| | + **name** | [**string**] | name of the CSINode | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSINode + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedCSIStorageCapacity + + + +> V1CSIStorageCapacity replaceNamespacedCSIStorageCapacity(body) + +replace the specified CSIStorageCapacity + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest = { + // name of the CSIStorageCapacity + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + capacity: "capacity_example", + kind: "kind_example", + maximumVolumeSize: "maximumVolumeSize_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + nodeTopology: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCSIStorageCapacity(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CSIStorageCapacity**| | + **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CSIStorageCapacity + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceStorageClass + + + +> V1StorageClass replaceStorageClass(body) + +replace the specified StorageClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceStorageClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceStorageClassRequest = { + // name of the StorageClass + name: "name_example", + + body: { + allowVolumeExpansion: true, + allowedTopologies: [ + { + matchLabelExpressions: [ + { + key: "key_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + mountOptions: [ + "mountOptions_example", + ], + parameters: { + "key": "key_example", + }, + provisioner: "provisioner_example", + reclaimPolicy: "reclaimPolicy_example", + volumeBindingMode: "volumeBindingMode_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StorageClass**| | + **name** | [**string**] | name of the StorageClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StorageClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceVolumeAttachment + + + +> V1VolumeAttachment replaceVolumeAttachment(body) + +replace the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceVolumeAttachmentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttachmentRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttachment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceVolumeAttachmentStatus + + + +> V1VolumeAttachment replaceVolumeAttachmentStatus(body) + +replace status of the specified VolumeAttachment + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttachmentStatusRequest = { + // name of the VolumeAttachment + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + attacher: "attacher_example", + nodeName: "nodeName_example", + source: { + inlineVolumeSpec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + persistentVolumeName: "persistentVolumeName_example", + }, + }, + status: { + attachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + attached: true, + attachmentMetadata: { + "key": "key_example", + }, + detachError: { + errorCode: 1, + message: "message_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttachmentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttachment**| | + **name** | [**string**] | name of the VolumeAttachment | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttachment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceVolumeAttributesClass + + + +> V1VolumeAttributesClass replaceVolumeAttributesClass(body) + +replace the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; +import type { StorageV1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1Api(configuration); + +const request: StorageV1ApiReplaceVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1VolumeAttributesClass**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1beta1Api.md new file mode 100644 index 00000000000..f868ee6bae8 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1beta1Api.md @@ -0,0 +1,719 @@ +--- +id: StorageV1beta1Api +title: StorageV1beta1Api +sidebar_label: StorageV1beta1Api +sidebar_position: 11 +--- +# StorageV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**deleteCollectionVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**deleteVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/StorageV1beta1Api#getAPIResources) | **GET** /apis/storage.k8s.io/v1beta1/ | +[**listVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | +[**patchVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**readVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | +[**replaceVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | + +### createVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass createVolumeAttributesClass(body) + +create a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiCreateVolumeAttributesClassRequest = { + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1VolumeAttributesClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionVolumeAttributesClass + + + +> V1Status deleteCollectionVolumeAttributesClass() + +delete collection of VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass deleteVolumeAttributesClass() + +delete a VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiDeleteVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listVolumeAttributesClass + + + +> V1beta1VolumeAttributesClassList listVolumeAttributesClass() + +list or watch objects of kind VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiListVolumeAttributesClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass patchVolumeAttributesClass(body) + +partially update the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiPatchVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass readVolumeAttributesClass() + +read the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiReadVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceVolumeAttributesClass + + + +> V1beta1VolumeAttributesClass replaceVolumeAttributesClass(body) + +replace the specified VolumeAttributesClass + +### Example + + +```typescript +import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; +import type { StorageV1beta1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StorageV1beta1Api(configuration); + +const request: StorageV1beta1ApiReplaceVolumeAttributesClassRequest = { + // name of the VolumeAttributesClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + driverName: "driverName_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + parameters: { + "key": "key_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceVolumeAttributesClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1VolumeAttributesClass**| | + **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1VolumeAttributesClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationApi.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationApi.md new file mode 100644 index 00000000000..c5297ac8c14 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationApi.md @@ -0,0 +1,62 @@ +--- +id: StoragemigrationApi +title: StoragemigrationApi +sidebar_label: StoragemigrationApi +sidebar_position: 8 +--- +# StoragemigrationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/configuration-storage/StoragemigrationApi#getAPIGroup) | **GET** /apis/storagemigration.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, StoragemigrationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationV1beta1Api.md new file mode 100644 index 00000000000..00238d62246 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationV1beta1Api.md @@ -0,0 +1,1016 @@ +--- +id: StoragemigrationV1beta1Api +title: StoragemigrationV1beta1Api +sidebar_label: StoragemigrationV1beta1Api +sidebar_position: 9 +--- +# StoragemigrationV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#createStorageVersionMigration) | **POST** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**deleteCollectionStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#deleteCollectionStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**deleteStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#deleteStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**getAPIResources**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#getAPIResources) | **GET** /apis/storagemigration.k8s.io/v1beta1/ | +[**listStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#listStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | +[**patchStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#patchStorageVersionMigration) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**patchStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#patchStorageVersionMigrationStatus) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | +[**readStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#readStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**readStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#readStorageVersionMigrationStatus) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | +[**replaceStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#replaceStorageVersionMigration) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | +[**replaceStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#replaceStorageVersionMigrationStatus) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | + +### createStorageVersionMigration + + + +> V1beta1StorageVersionMigration createStorageVersionMigration(body) + +create a StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionStorageVersionMigration + + + +> V1Status deleteCollectionStorageVersionMigration() + +delete collection of StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteStorageVersionMigration + + + +> V1Status deleteStorageVersionMigration() + +delete a StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listStorageVersionMigration + + + +> V1beta1StorageVersionMigrationList listStorageVersionMigration() + +list or watch objects of kind StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiListStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiListStorageVersionMigrationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigrationList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchStorageVersionMigration + + + +> V1beta1StorageVersionMigration patchStorageVersionMigration(body) + +partially update the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchStorageVersionMigrationStatus + + + +> V1beta1StorageVersionMigration patchStorageVersionMigrationStatus(body) + +partially update status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readStorageVersionMigration + + + +> V1beta1StorageVersionMigration readStorageVersionMigration() + +read the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readStorageVersionMigrationStatus + + + +> V1beta1StorageVersionMigration readStorageVersionMigrationStatus() + +read status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceStorageVersionMigration + + + +> V1beta1StorageVersionMigration replaceStorageVersionMigration(body) + +replace the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionMigration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceStorageVersionMigrationStatus + + + +> V1beta1StorageVersionMigration replaceStorageVersionMigrationStatus(body) + +replace status of the specified StorageVersionMigration + +### Example + + +```typescript +import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; +import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new StoragemigrationV1beta1Api(configuration); + +const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest = { + // name of the StorageVersionMigration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + resource: { + group: "group_example", + resource: "resource_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + resourceVersion: "resourceVersion_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionMigrationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1StorageVersionMigration**| | + **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1StorageVersionMigration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/_category_.json new file mode 100644 index 00000000000..6723fe67c06 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Configuration & Storage", + "position": 5 +} diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreApi.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreApi.md new file mode 100644 index 00000000000..23689cf7d5a --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreApi.md @@ -0,0 +1,62 @@ +--- +id: CoreApi +title: CoreApi +sidebar_label: CoreApi +sidebar_position: 1 +--- +# CoreApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIVersions**](/docs/api-reference/core-resources/CoreApi#getAPIVersions) | **GET** /api/ | + +### getAPIVersions + + + +> V1APIVersions getAPIVersions() + +get available API versions + +### Example + + +```typescript +import { createConfiguration, CoreApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIVersions(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIVersions + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreV1Api.md new file mode 100644 index 00000000000..13ef8d9adec --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreV1Api.md @@ -0,0 +1,39221 @@ +--- +id: CoreV1Api +title: CoreV1Api +sidebar_label: CoreV1Api +sidebar_position: 2 +--- +# CoreV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**connectDeleteNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedPodProxy) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectDeleteNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedPodProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectDeleteNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedServiceProxy) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectDeleteNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedServiceProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectDeleteNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNodeProxy) | **DELETE** /api/v1/nodes/{name}/proxy | +[**connectDeleteNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNodeProxyWithPath) | **DELETE** /api/v1/nodes/{name}/proxy/{path} | +[**connectGetNamespacedPodAttach**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodAttach) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/attach | +[**connectGetNamespacedPodExec**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodExec) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/exec | +[**connectGetNamespacedPodPortforward**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodPortforward) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/portforward | +[**connectGetNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodProxy) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectGetNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectGetNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedServiceProxy) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectGetNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedServiceProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectGetNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNodeProxy) | **GET** /api/v1/nodes/{name}/proxy | +[**connectGetNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNodeProxyWithPath) | **GET** /api/v1/nodes/{name}/proxy/{path} | +[**connectHeadNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedPodProxy) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectHeadNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedPodProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectHeadNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedServiceProxy) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectHeadNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedServiceProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectHeadNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNodeProxy) | **HEAD** /api/v1/nodes/{name}/proxy | +[**connectHeadNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNodeProxyWithPath) | **HEAD** /api/v1/nodes/{name}/proxy/{path} | +[**connectOptionsNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedPodProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectOptionsNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedPodProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectOptionsNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedServiceProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectOptionsNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedServiceProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectOptionsNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNodeProxy) | **OPTIONS** /api/v1/nodes/{name}/proxy | +[**connectOptionsNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNodeProxyWithPath) | **OPTIONS** /api/v1/nodes/{name}/proxy/{path} | +[**connectPatchNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedPodProxy) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPatchNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedPodProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPatchNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedServiceProxy) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPatchNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedServiceProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPatchNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNodeProxy) | **PATCH** /api/v1/nodes/{name}/proxy | +[**connectPatchNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNodeProxyWithPath) | **PATCH** /api/v1/nodes/{name}/proxy/{path} | +[**connectPostNamespacedPodAttach**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodAttach) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/attach | +[**connectPostNamespacedPodExec**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodExec) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/exec | +[**connectPostNamespacedPodPortforward**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodPortforward) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/portforward | +[**connectPostNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodProxy) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPostNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPostNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedServiceProxy) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPostNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedServiceProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPostNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNodeProxy) | **POST** /api/v1/nodes/{name}/proxy | +[**connectPostNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNodeProxyWithPath) | **POST** /api/v1/nodes/{name}/proxy/{path} | +[**connectPutNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedPodProxy) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy | +[**connectPutNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedPodProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | +[**connectPutNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedServiceProxy) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy | +[**connectPutNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedServiceProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | +[**connectPutNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNodeProxy) | **PUT** /api/v1/nodes/{name}/proxy | +[**connectPutNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNodeProxyWithPath) | **PUT** /api/v1/nodes/{name}/proxy/{path} | +[**createNamespace**](/docs/api-reference/core-resources/CoreV1Api#createNamespace) | **POST** /api/v1/namespaces | +[**createNamespacedBinding**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedBinding) | **POST** /api/v1/namespaces/{namespace}/bindings | +[**createNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedConfigMap) | **POST** /api/v1/namespaces/{namespace}/configmaps | +[**createNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedEndpoints) | **POST** /api/v1/namespaces/{namespace}/endpoints | +[**createNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedEvent) | **POST** /api/v1/namespaces/{namespace}/events | +[**createNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedLimitRange) | **POST** /api/v1/namespaces/{namespace}/limitranges | +[**createNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPersistentVolumeClaim) | **POST** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**createNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPod) | **POST** /api/v1/namespaces/{namespace}/pods | +[**createNamespacedPodBinding**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodBinding) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/binding | +[**createNamespacedPodEviction**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodEviction) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/eviction | +[**createNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodTemplate) | **POST** /api/v1/namespaces/{namespace}/podtemplates | +[**createNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedReplicationController) | **POST** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**createNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedResourceQuota) | **POST** /api/v1/namespaces/{namespace}/resourcequotas | +[**createNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedSecret) | **POST** /api/v1/namespaces/{namespace}/secrets | +[**createNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedService) | **POST** /api/v1/namespaces/{namespace}/services | +[**createNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedServiceAccount) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts | +[**createNamespacedServiceAccountToken**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedServiceAccountToken) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token | +[**createNode**](/docs/api-reference/core-resources/CoreV1Api#createNode) | **POST** /api/v1/nodes | +[**createPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#createPersistentVolume) | **POST** /api/v1/persistentvolumes | +[**deleteCollectionNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps | +[**deleteCollectionNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints | +[**deleteCollectionNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events | +[**deleteCollectionNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges | +[**deleteCollectionNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**deleteCollectionNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods | +[**deleteCollectionNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates | +[**deleteCollectionNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**deleteCollectionNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas | +[**deleteCollectionNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets | +[**deleteCollectionNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services | +[**deleteCollectionNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts | +[**deleteCollectionNode**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNode) | **DELETE** /api/v1/nodes | +[**deleteCollectionPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionPersistentVolume) | **DELETE** /api/v1/persistentvolumes | +[**deleteNamespace**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespace) | **DELETE** /api/v1/namespaces/{name} | +[**deleteNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**deleteNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**deleteNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events/{name} | +[**deleteNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**deleteNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**deleteNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name} | +[**deleteNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**deleteNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**deleteNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**deleteNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets/{name} | +[**deleteNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services/{name} | +[**deleteNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**deleteNode**](/docs/api-reference/core-resources/CoreV1Api#deleteNode) | **DELETE** /api/v1/nodes/{name} | +[**deletePersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#deletePersistentVolume) | **DELETE** /api/v1/persistentvolumes/{name} | +[**getAPIResources**](/docs/api-reference/core-resources/CoreV1Api#getAPIResources) | **GET** /api/v1/ | +[**listComponentStatus**](/docs/api-reference/core-resources/CoreV1Api#listComponentStatus) | **GET** /api/v1/componentstatuses | +[**listConfigMapForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listConfigMapForAllNamespaces) | **GET** /api/v1/configmaps | +[**listEndpointsForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listEndpointsForAllNamespaces) | **GET** /api/v1/endpoints | +[**listEventForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listEventForAllNamespaces) | **GET** /api/v1/events | +[**listLimitRangeForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listLimitRangeForAllNamespaces) | **GET** /api/v1/limitranges | +[**listNamespace**](/docs/api-reference/core-resources/CoreV1Api#listNamespace) | **GET** /api/v1/namespaces | +[**listNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps | +[**listNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints | +[**listNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events | +[**listNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges | +[**listNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims | +[**listNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods | +[**listNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates | +[**listNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers | +[**listNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas | +[**listNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets | +[**listNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services | +[**listNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts | +[**listNode**](/docs/api-reference/core-resources/CoreV1Api#listNode) | **GET** /api/v1/nodes | +[**listPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#listPersistentVolume) | **GET** /api/v1/persistentvolumes | +[**listPersistentVolumeClaimForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPersistentVolumeClaimForAllNamespaces) | **GET** /api/v1/persistentvolumeclaims | +[**listPodForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPodForAllNamespaces) | **GET** /api/v1/pods | +[**listPodTemplateForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPodTemplateForAllNamespaces) | **GET** /api/v1/podtemplates | +[**listReplicationControllerForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listReplicationControllerForAllNamespaces) | **GET** /api/v1/replicationcontrollers | +[**listResourceQuotaForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listResourceQuotaForAllNamespaces) | **GET** /api/v1/resourcequotas | +[**listSecretForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listSecretForAllNamespaces) | **GET** /api/v1/secrets | +[**listServiceAccountForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listServiceAccountForAllNamespaces) | **GET** /api/v1/serviceaccounts | +[**listServiceForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listServiceForAllNamespaces) | **GET** /api/v1/services | +[**patchNamespace**](/docs/api-reference/core-resources/CoreV1Api#patchNamespace) | **PATCH** /api/v1/namespaces/{name} | +[**patchNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespaceStatus) | **PATCH** /api/v1/namespaces/{name}/status | +[**patchNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedConfigMap) | **PATCH** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**patchNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedEndpoints) | **PATCH** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**patchNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedEvent) | **PATCH** /api/v1/namespaces/{namespace}/events/{name} | +[**patchNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedLimitRange) | **PATCH** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**patchNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPersistentVolumeClaim) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**patchNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPersistentVolumeClaimStatus) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**patchNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPod) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name} | +[**patchNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodEphemeralcontainers) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**patchNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodResize) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**patchNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodStatus) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**patchNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodTemplate) | **PATCH** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**patchNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationController) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**patchNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationControllerScale) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**patchNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationControllerStatus) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**patchNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedResourceQuota) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**patchNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedResourceQuotaStatus) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**patchNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedSecret) | **PATCH** /api/v1/namespaces/{namespace}/secrets/{name} | +[**patchNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedService) | **PATCH** /api/v1/namespaces/{namespace}/services/{name} | +[**patchNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedServiceAccount) | **PATCH** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**patchNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedServiceStatus) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/status | +[**patchNode**](/docs/api-reference/core-resources/CoreV1Api#patchNode) | **PATCH** /api/v1/nodes/{name} | +[**patchNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNodeStatus) | **PATCH** /api/v1/nodes/{name}/status | +[**patchPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#patchPersistentVolume) | **PATCH** /api/v1/persistentvolumes/{name} | +[**patchPersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#patchPersistentVolumeStatus) | **PATCH** /api/v1/persistentvolumes/{name}/status | +[**readComponentStatus**](/docs/api-reference/core-resources/CoreV1Api#readComponentStatus) | **GET** /api/v1/componentstatuses/{name} | +[**readNamespace**](/docs/api-reference/core-resources/CoreV1Api#readNamespace) | **GET** /api/v1/namespaces/{name} | +[**readNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespaceStatus) | **GET** /api/v1/namespaces/{name}/status | +[**readNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**readNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**readNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events/{name} | +[**readNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**readNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**readNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPersistentVolumeClaimStatus) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**readNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods/{name} | +[**readNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodEphemeralcontainers) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**readNamespacedPodLog**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodLog) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/log | +[**readNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodResize) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**readNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodStatus) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**readNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**readNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**readNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationControllerScale) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**readNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationControllerStatus) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**readNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**readNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedResourceQuotaStatus) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**readNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets/{name} | +[**readNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services/{name} | +[**readNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**readNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedServiceStatus) | **GET** /api/v1/namespaces/{namespace}/services/{name}/status | +[**readNode**](/docs/api-reference/core-resources/CoreV1Api#readNode) | **GET** /api/v1/nodes/{name} | +[**readNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#readNodeStatus) | **GET** /api/v1/nodes/{name}/status | +[**readPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#readPersistentVolume) | **GET** /api/v1/persistentvolumes/{name} | +[**readPersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#readPersistentVolumeStatus) | **GET** /api/v1/persistentvolumes/{name}/status | +[**replaceNamespace**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespace) | **PUT** /api/v1/namespaces/{name} | +[**replaceNamespaceFinalize**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespaceFinalize) | **PUT** /api/v1/namespaces/{name}/finalize | +[**replaceNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespaceStatus) | **PUT** /api/v1/namespaces/{name}/status | +[**replaceNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedConfigMap) | **PUT** /api/v1/namespaces/{namespace}/configmaps/{name} | +[**replaceNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedEndpoints) | **PUT** /api/v1/namespaces/{namespace}/endpoints/{name} | +[**replaceNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedEvent) | **PUT** /api/v1/namespaces/{namespace}/events/{name} | +[**replaceNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedLimitRange) | **PUT** /api/v1/namespaces/{namespace}/limitranges/{name} | +[**replaceNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPersistentVolumeClaim) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | +[**replaceNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPersistentVolumeClaimStatus) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | +[**replaceNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPod) | **PUT** /api/v1/namespaces/{namespace}/pods/{name} | +[**replaceNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodEphemeralcontainers) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | +[**replaceNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodResize) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/resize | +[**replaceNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodStatus) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/status | +[**replaceNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodTemplate) | **PUT** /api/v1/namespaces/{namespace}/podtemplates/{name} | +[**replaceNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationController) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | +[**replaceNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationControllerScale) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | +[**replaceNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationControllerStatus) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | +[**replaceNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedResourceQuota) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name} | +[**replaceNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedResourceQuotaStatus) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | +[**replaceNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedSecret) | **PUT** /api/v1/namespaces/{namespace}/secrets/{name} | +[**replaceNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedService) | **PUT** /api/v1/namespaces/{namespace}/services/{name} | +[**replaceNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedServiceAccount) | **PUT** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | +[**replaceNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedServiceStatus) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/status | +[**replaceNode**](/docs/api-reference/core-resources/CoreV1Api#replaceNode) | **PUT** /api/v1/nodes/{name} | +[**replaceNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNodeStatus) | **PUT** /api/v1/nodes/{name}/status | +[**replacePersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#replacePersistentVolume) | **PUT** /api/v1/persistentvolumes/{name} | +[**replacePersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#replacePersistentVolumeStatus) | **PUT** /api/v1/persistentvolumes/{name}/status | + +### connectDeleteNamespacedPodProxy + + + +> string connectDeleteNamespacedPodProxy() + +connect DELETE requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNamespacedPodProxyWithPath + + + +> string connectDeleteNamespacedPodProxyWithPath() + +connect DELETE requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNamespacedServiceProxy + + + +> string connectDeleteNamespacedServiceProxy() + +connect DELETE requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNamespacedServiceProxyWithPath + + + +> string connectDeleteNamespacedServiceProxyWithPath() + +connect DELETE requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNodeProxy + + + +> string connectDeleteNodeProxy() + +connect DELETE requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectDeleteNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectDeleteNodeProxyWithPath + + + +> string connectDeleteNodeProxyWithPath() + +connect DELETE requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectDeleteNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectDeleteNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectDeleteNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodAttach + + + +> string connectGetNamespacedPodAttach() + +connect GET requests to attach of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodAttachRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodAttachRequest = { + // name of the PodAttachOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) + stderr: true, + // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectGetNamespacedPodAttach(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodAttachOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodExec + + + +> string connectGetNamespacedPodExec() + +connect GET requests to exec of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodExecRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodExecRequest = { + // name of the PodExecOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Command is the remote command to execute. argv array. Not executed within a shell. (optional) + command: "command_example", + // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Redirect the standard error stream of the pod for this call. (optional) + stderr: true, + // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Redirect the standard output stream of the pod for this call. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectGetNamespacedPodExec(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodExecOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined + **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined + **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodPortforward + + + +> string connectGetNamespacedPodPortforward() + +connect GET requests to portforward of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodPortforwardRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodPortforwardRequest = { + // name of the PodPortForwardOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // List of ports to forward Required when using WebSockets (optional) + ports: 1, +}; + +const data = await apiInstance.connectGetNamespacedPodPortforward(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodProxy + + + +> string connectGetNamespacedPodProxy() + +connect GET requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedPodProxyWithPath + + + +> string connectGetNamespacedPodProxyWithPath() + +connect GET requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedServiceProxy + + + +> string connectGetNamespacedServiceProxy() + +connect GET requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNamespacedServiceProxyWithPath + + + +> string connectGetNamespacedServiceProxyWithPath() + +connect GET requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNodeProxy + + + +> string connectGetNodeProxy() + +connect GET requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectGetNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectGetNodeProxyWithPath + + + +> string connectGetNodeProxyWithPath() + +connect GET requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectGetNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectGetNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectGetNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNamespacedPodProxy + + + +> string connectHeadNamespacedPodProxy() + +connect HEAD requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNamespacedPodProxyWithPath + + + +> string connectHeadNamespacedPodProxyWithPath() + +connect HEAD requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNamespacedServiceProxy + + + +> string connectHeadNamespacedServiceProxy() + +connect HEAD requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNamespacedServiceProxyWithPath + + + +> string connectHeadNamespacedServiceProxyWithPath() + +connect HEAD requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNodeProxy + + + +> string connectHeadNodeProxy() + +connect HEAD requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectHeadNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectHeadNodeProxyWithPath + + + +> string connectHeadNodeProxyWithPath() + +connect HEAD requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectHeadNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectHeadNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectHeadNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNamespacedPodProxy + + + +> string connectOptionsNamespacedPodProxy() + +connect OPTIONS requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNamespacedPodProxyWithPath + + + +> string connectOptionsNamespacedPodProxyWithPath() + +connect OPTIONS requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNamespacedServiceProxy + + + +> string connectOptionsNamespacedServiceProxy() + +connect OPTIONS requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNamespacedServiceProxyWithPath + + + +> string connectOptionsNamespacedServiceProxyWithPath() + +connect OPTIONS requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNodeProxy + + + +> string connectOptionsNodeProxy() + +connect OPTIONS requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectOptionsNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectOptionsNodeProxyWithPath + + + +> string connectOptionsNodeProxyWithPath() + +connect OPTIONS requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectOptionsNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectOptionsNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectOptionsNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNamespacedPodProxy + + + +> string connectPatchNamespacedPodProxy() + +connect PATCH requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNamespacedPodProxyWithPath + + + +> string connectPatchNamespacedPodProxyWithPath() + +connect PATCH requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNamespacedServiceProxy + + + +> string connectPatchNamespacedServiceProxy() + +connect PATCH requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNamespacedServiceProxyWithPath + + + +> string connectPatchNamespacedServiceProxyWithPath() + +connect PATCH requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNodeProxy + + + +> string connectPatchNodeProxy() + +connect PATCH requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPatchNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPatchNodeProxyWithPath + + + +> string connectPatchNodeProxyWithPath() + +connect PATCH requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPatchNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPatchNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPatchNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodAttach + + + +> string connectPostNamespacedPodAttach() + +connect POST requests to attach of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodAttachRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodAttachRequest = { + // name of the PodAttachOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) + stderr: true, + // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectPostNamespacedPodAttach(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodAttachOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodExec + + + +> string connectPostNamespacedPodExec() + +connect POST requests to exec of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodExecRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodExecRequest = { + // name of the PodExecOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Command is the remote command to execute. argv array. Not executed within a shell. (optional) + command: "command_example", + // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) + container: "container_example", + // Redirect the standard error stream of the pod for this call. (optional) + stderr: true, + // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) + stdin: true, + // Redirect the standard output stream of the pod for this call. (optional) + stdout: true, + // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) + tty: true, +}; + +const data = await apiInstance.connectPostNamespacedPodExec(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodExecOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined + **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined + **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined + **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined + **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined + **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodPortforward + + + +> string connectPostNamespacedPodPortforward() + +connect POST requests to portforward of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodPortforwardRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodPortforwardRequest = { + // name of the PodPortForwardOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // List of ports to forward Required when using WebSockets (optional) + ports: 1, +}; + +const data = await apiInstance.connectPostNamespacedPodPortforward(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodProxy + + + +> string connectPostNamespacedPodProxy() + +connect POST requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedPodProxyWithPath + + + +> string connectPostNamespacedPodProxyWithPath() + +connect POST requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedServiceProxy + + + +> string connectPostNamespacedServiceProxy() + +connect POST requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNamespacedServiceProxyWithPath + + + +> string connectPostNamespacedServiceProxyWithPath() + +connect POST requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNodeProxy + + + +> string connectPostNodeProxy() + +connect POST requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPostNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPostNodeProxyWithPath + + + +> string connectPostNodeProxyWithPath() + +connect POST requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPostNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPostNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPostNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNamespacedPodProxy + + + +> string connectPutNamespacedPodProxy() + +connect PUT requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNamespacedPodProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedPodProxyRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedPodProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNamespacedPodProxyWithPath + + + +> string connectPutNamespacedPodProxyWithPath() + +connect PUT requests to proxy of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest = { + // name of the PodProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to pod. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedPodProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNamespacedServiceProxy + + + +> string connectPutNamespacedServiceProxy() + +connect PUT requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNamespacedServiceProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedServiceProxyRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedServiceProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNamespacedServiceProxyWithPath + + + +> string connectPutNamespacedServiceProxyWithPath() + +connect PUT requests to proxy of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest = { + // name of the ServiceProxyOptions + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // path to the resource + path: "path_example", + // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNamespacedServiceProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNodeProxy + + + +> string connectPutNodeProxy() + +connect PUT requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNodeProxyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNodeProxyRequest = { + // name of the NodeProxyOptions + name: "name_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path: "path_example", +}; + +const data = await apiInstance.connectPutNodeProxy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### connectPutNodeProxyWithPath + + + +> string connectPutNodeProxyWithPath() + +connect PUT requests to proxy of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiConnectPutNodeProxyWithPathRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiConnectPutNodeProxyWithPathRequest = { + // name of the NodeProxyOptions + name: "name_example", + // path to the resource + path: "path_example", + // Path is the URL path to use for the current proxy request to node. (optional) + path2: "path_example", +}; + +const data = await apiInstance.connectPutNodeProxyWithPath(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined + **path** | [**string**] | path to the resource | defaults to undefined + **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### createNamespace + + + +> V1Namespace createNamespace(body) + +create a Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespaceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedBinding + + + +> V1Binding createNamespacedBinding(body) + +create a Binding + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + target: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Binding**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Binding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedConfigMap + + + +> V1ConfigMap createNamespacedConfigMap(body) + +create a ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + binaryData: { + "key": 'YQ==', + }, + data: { + "key": "key_example", + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ConfigMap**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ConfigMap + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedEndpoints + + + +> V1Endpoints createNamespacedEndpoints(body) + +create Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + subsets: [ + { + addresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + notReadyAddresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Endpoints**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Endpoints + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedEvent + + + +> CoreV1Event createNamespacedEvent(body) + +create an Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + count: 1, + eventTime: "eventTime_example", + firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + involvedObject: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + kind: "kind_example", + lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + reason: "reason_example", + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingComponent: "reportingComponent_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + source: { + component: "component_example", + host: "host_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **CoreV1Event**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +CoreV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedLimitRange + + + +> V1LimitRange createNamespacedLimitRange(body) + +create a LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + limits: [ + { + _default: { + "key": "key_example", + }, + defaultRequest: { + "key": "key_example", + }, + max: { + "key": "key_example", + }, + maxLimitRequestRatio: { + "key": "key_example", + }, + min: { + "key": "key_example", + }, + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LimitRange**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1LimitRange + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim createNamespacedPersistentVolumeClaim(body) + +create a PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPod + + + +> V1Pod createNamespacedPod(body) + +create a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPodBinding + + + +> V1Binding createNamespacedPodBinding(body) + +create binding of a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPodBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodBindingRequest = { + // name of the Binding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + target: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedPodBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Binding**| | + **name** | [**string**] | name of the Binding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Binding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPodEviction + + + +> V1Eviction createNamespacedPodEviction(body) + +create eviction of a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPodEvictionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodEvictionRequest = { + // name of the Eviction + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + deleteOptions: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedPodEviction(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Eviction**| | + **name** | [**string**] | name of the Eviction | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Eviction + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPodTemplate + + + +> V1PodTemplate createNamespacedPodTemplate(body) + +create a PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedReplicationController + + + +> V1ReplicationController createNamespacedReplicationController(body) + +create a ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceQuota + + + +> V1ResourceQuota createNamespacedResourceQuota(body) + +create a ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedSecret + + + +> V1Secret createNamespacedSecret(body) + +create a Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: { + "key": 'YQ==', + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + stringData: { + "key": "key_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Secret**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Secret + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedService + + + +> V1Service createNamespacedService(body) + +create a Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedServiceAccount + + + +> V1ServiceAccount createNamespacedServiceAccount(body) + +create a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + automountServiceAccountToken: true, + imagePullSecrets: [ + { + name: "name_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + secrets: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceAccount**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedServiceAccountToken + + + +> AuthenticationV1TokenRequest createNamespacedServiceAccountToken(body) + +create token of a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNamespacedServiceAccountTokenRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNamespacedServiceAccountTokenRequest = { + // name of the TokenRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + audiences: [ + "audiences_example", + ], + boundObjectRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + expirationSeconds: 1, + }, + status: { + expirationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + token: "token_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedServiceAccountToken(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **AuthenticationV1TokenRequest**| | + **name** | [**string**] | name of the TokenRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +AuthenticationV1TokenRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNode + + + +> V1Node createNode(body) + +create a Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreateNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreateNodeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createPersistentVolume + + + +> V1PersistentVolume createPersistentVolume(body) + +create a PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiCreatePersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiCreatePersistentVolumeRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedConfigMap + + + +> V1Status deleteCollectionNamespacedConfigMap() + +delete collection of ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedEndpoints + + + +> V1Status deleteCollectionNamespacedEndpoints() + +delete collection of Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedEvent + + + +> V1Status deleteCollectionNamespacedEvent() + +delete collection of Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedLimitRange + + + +> V1Status deleteCollectionNamespacedLimitRange() + +delete collection of LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPersistentVolumeClaim + + + +> V1Status deleteCollectionNamespacedPersistentVolumeClaim() + +delete collection of PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPod + + + +> V1Status deleteCollectionNamespacedPod() + +delete collection of Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPodTemplate + + + +> V1Status deleteCollectionNamespacedPodTemplate() + +delete collection of PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedReplicationController + + + +> V1Status deleteCollectionNamespacedReplicationController() + +delete collection of ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceQuota + + + +> V1Status deleteCollectionNamespacedResourceQuota() + +delete collection of ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedSecret + + + +> V1Status deleteCollectionNamespacedSecret() + +delete collection of Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedService + + + +> V1Status deleteCollectionNamespacedService() + +delete collection of Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedServiceAccount + + + +> V1Status deleteCollectionNamespacedServiceAccount() + +delete collection of ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNode + + + +> V1Status deleteCollectionNode() + +delete collection of Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionNodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionPersistentVolume + + + +> V1Status deleteCollectionPersistentVolume() + +delete collection of PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteCollectionPersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteCollectionPersistentVolumeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespace + + + +> V1Status deleteNamespace() + +delete a Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespaceRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedConfigMap + + + +> V1Status deleteNamespacedConfigMap() + +delete a ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedEndpoints + + + +> V1Status deleteNamespacedEndpoints() + +delete Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedEvent + + + +> V1Status deleteNamespacedEvent() + +delete an Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedLimitRange + + + +> V1Status deleteNamespacedLimitRange() + +delete a LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim deleteNamespacedPersistentVolumeClaim() + +delete a PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedPod + + + +> V1Pod deleteNamespacedPod() + +delete a Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedPodTemplate + + + +> V1PodTemplate deleteNamespacedPodTemplate() + +delete a PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedReplicationController + + + +> V1Status deleteNamespacedReplicationController() + +delete a ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceQuota + + + +> V1ResourceQuota deleteNamespacedResourceQuota() + +delete a ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedSecret + + + +> V1Status deleteNamespacedSecret() + +delete a Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedService + + + +> V1Service deleteNamespacedService() + +delete a Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedServiceAccount + + + +> V1ServiceAccount deleteNamespacedServiceAccount() + +delete a ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNode + + + +> V1Status deleteNode() + +delete a Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeleteNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeleteNodeRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deletePersistentVolume + + + +> V1PersistentVolume deletePersistentVolume() + +delete a PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiDeletePersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiDeletePersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listComponentStatus + + + +> V1ComponentStatusList listComponentStatus() + +list objects of kind ComponentStatus + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListComponentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListComponentStatusRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listComponentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ComponentStatusList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listConfigMapForAllNamespaces + + + +> V1ConfigMapList listConfigMapForAllNamespaces() + +list or watch objects of kind ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListConfigMapForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListConfigMapForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listConfigMapForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ConfigMapList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listEndpointsForAllNamespaces + + + +> V1EndpointsList listEndpointsForAllNamespaces() + +list or watch objects of kind Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListEndpointsForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListEndpointsForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEndpointsForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1EndpointsList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listEventForAllNamespaces + + + +> CoreV1EventList listEventForAllNamespaces() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListEventForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListEventForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEventForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +CoreV1EventList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listLimitRangeForAllNamespaces + + + +> V1LimitRangeList listLimitRangeForAllNamespaces() + +list or watch objects of kind LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListLimitRangeForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListLimitRangeForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listLimitRangeForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1LimitRangeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespace + + + +> V1NamespaceList listNamespace() + +list or watch objects of kind Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespaceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1NamespaceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedConfigMap + + + +> V1ConfigMapList listNamespacedConfigMap() + +list or watch objects of kind ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedConfigMapRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ConfigMapList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedEndpoints + + + +> V1EndpointsList listNamespacedEndpoints() + +list or watch objects of kind Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedEndpointsRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1EndpointsList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedEvent + + + +> CoreV1EventList listNamespacedEvent() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +CoreV1EventList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedLimitRange + + + +> V1LimitRangeList listNamespacedLimitRange() + +list or watch objects of kind LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedLimitRangeRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1LimitRangeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaimList listNamespacedPersistentVolumeClaim() + +list or watch objects of kind PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPersistentVolumeClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPod + + + +> V1PodList listNamespacedPod() + +list or watch objects of kind Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPodRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPodTemplate + + + +> V1PodTemplateList listNamespacedPodTemplate() + +list or watch objects of kind PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedPodTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedReplicationController + + + +> V1ReplicationControllerList listNamespacedReplicationController() + +list or watch objects of kind ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedReplicationControllerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ReplicationControllerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceQuota + + + +> V1ResourceQuotaList listNamespacedResourceQuota() + +list or watch objects of kind ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedResourceQuotaRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceQuotaList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedSecret + + + +> V1SecretList listNamespacedSecret() + +list or watch objects of kind Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedSecretRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1SecretList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedService + + + +> V1ServiceList listNamespacedService() + +list or watch objects of kind Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedServiceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedServiceAccount + + + +> V1ServiceAccountList listNamespacedServiceAccount() + +list or watch objects of kind ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNamespacedServiceAccountRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceAccountList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNode + + + +> V1NodeList listNode() + +list or watch objects of kind Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListNodeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1NodeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPersistentVolume + + + +> V1PersistentVolumeList listPersistentVolume() + +list or watch objects of kind PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListPersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPersistentVolumeRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPersistentVolumeClaimForAllNamespaces + + + +> V1PersistentVolumeClaimList listPersistentVolumeClaimForAllNamespaces() + +list or watch objects of kind PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPersistentVolumeClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPodForAllNamespaces + + + +> V1PodList listPodForAllNamespaces() + +list or watch objects of kind Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListPodForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPodForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPodTemplateForAllNamespaces + + + +> V1PodTemplateList listPodTemplateForAllNamespaces() + +list or watch objects of kind PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListPodTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListPodTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PodTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listReplicationControllerForAllNamespaces + + + +> V1ReplicationControllerList listReplicationControllerForAllNamespaces() + +list or watch objects of kind ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListReplicationControllerForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListReplicationControllerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listReplicationControllerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ReplicationControllerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceQuotaForAllNamespaces + + + +> V1ResourceQuotaList listResourceQuotaForAllNamespaces() + +list or watch objects of kind ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListResourceQuotaForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListResourceQuotaForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceQuotaForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceQuotaList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listSecretForAllNamespaces + + + +> V1SecretList listSecretForAllNamespaces() + +list or watch objects of kind Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListSecretForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListSecretForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listSecretForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1SecretList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listServiceAccountForAllNamespaces + + + +> V1ServiceAccountList listServiceAccountForAllNamespaces() + +list or watch objects of kind ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListServiceAccountForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListServiceAccountForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceAccountForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceAccountList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listServiceForAllNamespaces + + + +> V1ServiceList listServiceForAllNamespaces() + +list or watch objects of kind Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiListServiceForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiListServiceForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespace + + + +> V1Namespace patchNamespace(body) + +partially update the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespaceRequest = { + // name of the Namespace + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespaceStatus + + + +> V1Namespace patchNamespaceStatus(body) + +partially update status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespaceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedConfigMap + + + +> V1ConfigMap patchNamespacedConfigMap(body) + +partially update the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ConfigMap + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedEndpoints + + + +> V1Endpoints patchNamespacedEndpoints(body) + +partially update the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Endpoints + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedEvent + + + +> CoreV1Event patchNamespacedEvent(body) + +partially update the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +CoreV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedLimitRange + + + +> V1LimitRange patchNamespacedLimitRange(body) + +partially update the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1LimitRange + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaim(body) + +partially update the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPersistentVolumeClaimStatus + + + +> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaimStatus(body) + +partially update status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPod + + + +> V1Pod patchNamespacedPod(body) + +partially update the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodEphemeralcontainers + + + +> V1Pod patchNamespacedPodEphemeralcontainers(body) + +partially update ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodResize + + + +> V1Pod patchNamespacedPodResize(body) + +partially update resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodResizeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodStatus + + + +> V1Pod patchNamespacedPodStatus(body) + +partially update status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodTemplate + + + +> V1PodTemplate patchNamespacedPodTemplate(body) + +partially update the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicationController + + + +> V1ReplicationController patchNamespacedReplicationController(body) + +partially update the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicationControllerScale + + + +> V1Scale patchNamespacedReplicationControllerScale(body) + +partially update scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicationControllerStatus + + + +> V1ReplicationController patchNamespacedReplicationControllerStatus(body) + +partially update status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceQuota + + + +> V1ResourceQuota patchNamespacedResourceQuota(body) + +partially update the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceQuotaStatus + + + +> V1ResourceQuota patchNamespacedResourceQuotaStatus(body) + +partially update status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedSecret + + + +> V1Secret patchNamespacedSecret(body) + +partially update the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Secret + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedService + + + +> V1Service patchNamespacedService(body) + +partially update the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedServiceAccount + + + +> V1ServiceAccount patchNamespacedServiceAccount(body) + +partially update the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedServiceStatus + + + +> V1Service patchNamespacedServiceStatus(body) + +partially update status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNamespacedServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNode + + + +> V1Node patchNode(body) + +partially update the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNodeRequest = { + // name of the Node + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNodeStatus + + + +> V1Node patchNodeStatus(body) + +partially update status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchNodeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchNodeStatusRequest = { + // name of the Node + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchPersistentVolume + + + +> V1PersistentVolume patchPersistentVolume(body) + +partially update the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchPersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchPersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchPersistentVolumeStatus + + + +> V1PersistentVolume patchPersistentVolumeStatus(body) + +partially update status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiPatchPersistentVolumeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiPatchPersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readComponentStatus + + + +> V1ComponentStatus readComponentStatus() + +read the specified ComponentStatus + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadComponentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadComponentStatusRequest = { + // name of the ComponentStatus + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readComponentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ComponentStatus | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ComponentStatus + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespace + + + +> V1Namespace readNamespace() + +read the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespaceRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespaceStatus + + + +> V1Namespace readNamespaceStatus() + +read status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespaceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedConfigMap + + + +> V1ConfigMap readNamespacedConfigMap() + +read the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ConfigMap + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedEndpoints + + + +> V1Endpoints readNamespacedEndpoints() + +read the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Endpoints + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedEvent + + + +> CoreV1Event readNamespacedEvent() + +read the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +CoreV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedLimitRange + + + +> V1LimitRange readNamespacedLimitRange() + +read the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1LimitRange + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaim() + +read the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPersistentVolumeClaimStatus + + + +> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaimStatus() + +read status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPod + + + +> V1Pod readNamespacedPod() + +read the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodEphemeralcontainers + + + +> V1Pod readNamespacedPodEphemeralcontainers() + +read ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodLog + + + +> string readNamespacedPodLog() + +read log of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodLogRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodLogRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // The container for which to stream logs. Defaults to only container if there is one container in the pod. (optional) + container: "container_example", + // Follow the log stream of the pod. Defaults to false. (optional) + follow: true, + // insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). (optional) + insecureSkipTLSVerifyBackend: true, + // If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. (optional) + limitBytes: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // Return previous terminated container logs. Defaults to false. (optional) + previous: true, + // A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. (optional) + sinceSeconds: 1, + // Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) + stream: "stream_example", + // If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) + tailLines: 1, + // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. (optional) + timestamps: true, +}; + +const data = await apiInstance.readNamespacedPodLog(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **container** | [**string**] | The container for which to stream logs. Defaults to only container if there is one container in the pod. | (optional) defaults to undefined + **follow** | [**boolean**] | Follow the log stream of the pod. Defaults to false. | (optional) defaults to undefined + **insecureSkipTLSVerifyBackend** | [**boolean**] | insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). | (optional) defaults to undefined + **limitBytes** | [**number**] | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **previous** | [**boolean**] | Return previous terminated container logs. Defaults to false. | (optional) defaults to undefined + **sinceSeconds** | [**number**] | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | (optional) defaults to undefined + **stream** | [**string**] | Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined + **tailLines** | [**number**] | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined + **timestamps** | [**boolean**] | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. | (optional) defaults to undefined + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodResize + + + +> V1Pod readNamespacedPodResize() + +read resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodResizeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodStatus + + + +> V1Pod readNamespacedPodStatus() + +read status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodTemplate + + + +> V1PodTemplate readNamespacedPodTemplate() + +read the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicationController + + + +> V1ReplicationController readNamespacedReplicationController() + +read the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicationControllerScale + + + +> V1Scale readNamespacedReplicationControllerScale() + +read scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicationControllerStatus + + + +> V1ReplicationController readNamespacedReplicationControllerStatus() + +read status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceQuota + + + +> V1ResourceQuota readNamespacedResourceQuota() + +read the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceQuotaStatus + + + +> V1ResourceQuota readNamespacedResourceQuotaStatus() + +read status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedSecret + + + +> V1Secret readNamespacedSecret() + +read the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Secret + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedService + + + +> V1Service readNamespacedService() + +read the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedServiceAccount + + + +> V1ServiceAccount readNamespacedServiceAccount() + +read the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedServiceStatus + + + +> V1Service readNamespacedServiceStatus() + +read status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNamespacedServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNode + + + +> V1Node readNode() + +read the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNodeRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNodeStatus + + + +> V1Node readNodeStatus() + +read status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadNodeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadNodeStatusRequest = { + // name of the Node + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readPersistentVolume + + + +> V1PersistentVolume readPersistentVolume() + +read the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadPersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadPersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readPersistentVolumeStatus + + + +> V1PersistentVolume readPersistentVolumeStatus() + +read status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReadPersistentVolumeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReadPersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespace + + + +> V1Namespace replaceNamespace(body) + +replace the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespaceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespace(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespaceFinalize + + + +> V1Namespace replaceNamespaceFinalize(body) + +replace finalize of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespaceFinalizeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceFinalizeRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.replaceNamespaceFinalize(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespaceStatus + + + +> V1Namespace replaceNamespaceStatus(body) + +replace status of the specified Namespace + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespaceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespaceStatusRequest = { + // name of the Namespace + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + finalizers: [ + "finalizers_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespaceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Namespace**| | + **name** | [**string**] | name of the Namespace | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Namespace + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedConfigMap + + + +> V1ConfigMap replaceNamespacedConfigMap(body) + +replace the specified ConfigMap + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedConfigMapRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedConfigMapRequest = { + // name of the ConfigMap + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + binaryData: { + "key": 'YQ==', + }, + data: { + "key": "key_example", + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedConfigMap(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ConfigMap**| | + **name** | [**string**] | name of the ConfigMap | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ConfigMap + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedEndpoints + + + +> V1Endpoints replaceNamespacedEndpoints(body) + +replace the specified Endpoints + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedEndpointsRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedEndpointsRequest = { + // name of the Endpoints + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + subsets: [ + { + addresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + notReadyAddresses: [ + { + hostname: "hostname_example", + ip: "ip_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEndpoints(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Endpoints**| | + **name** | [**string**] | name of the Endpoints | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Endpoints + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedEvent + + + +> CoreV1Event replaceNamespacedEvent(body) + +replace the specified Event + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + count: 1, + eventTime: "eventTime_example", + firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + involvedObject: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + kind: "kind_example", + lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + reason: "reason_example", + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingComponent: "reportingComponent_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + source: { + component: "component_example", + host: "host_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **CoreV1Event**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +CoreV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedLimitRange + + + +> V1LimitRange replaceNamespacedLimitRange(body) + +replace the specified LimitRange + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedLimitRangeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedLimitRangeRequest = { + // name of the LimitRange + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + limits: [ + { + _default: { + "key": "key_example", + }, + defaultRequest: { + "key": "key_example", + }, + max: { + "key": "key_example", + }, + maxLimitRequestRatio: { + "key": "key_example", + }, + min: { + "key": "key_example", + }, + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedLimitRange(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LimitRange**| | + **name** | [**string**] | name of the LimitRange | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1LimitRange + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPersistentVolumeClaim + + + +> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaim(body) + +replace the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPersistentVolumeClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPersistentVolumeClaimStatus + + + +> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaimStatus(body) + +replace status of the specified PersistentVolumeClaim + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest = { + // name of the PersistentVolumeClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPersistentVolumeClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolumeClaim**| | + **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolumeClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPod + + + +> V1Pod replaceNamespacedPod(body) + +replace the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPod(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodEphemeralcontainers + + + +> V1Pod replaceNamespacedPodEphemeralcontainers(body) + +replace ephemeralcontainers of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodEphemeralcontainers(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodResize + + + +> V1Pod replaceNamespacedPodResize(body) + +replace resize of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodResizeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodResizeRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodResize(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodStatus + + + +> V1Pod replaceNamespacedPodStatus(body) + +replace status of the specified Pod + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodStatusRequest = { + // name of the Pod + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + status: { + allocatedResources: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + containerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + ephemeralContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + extendedResourceClaimStatus: { + requestMappings: [ + { + containerName: "containerName_example", + requestName: "requestName_example", + resourceName: "resourceName_example", + }, + ], + resourceClaimName: "resourceClaimName_example", + }, + hostIP: "hostIP_example", + hostIPs: [ + { + ip: "ip_example", + }, + ], + initContainerStatuses: [ + { + allocatedResources: { + "key": "key_example", + }, + allocatedResourcesStatus: [ + { + name: "name_example", + resources: [ + { + health: "health_example", + resourceID: "resourceID_example", + }, + ], + }, + ], + containerID: "containerID_example", + image: "image_example", + imageID: "imageID_example", + lastState: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + name: "name_example", + ready: true, + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartCount: 1, + started: true, + state: { + running: { + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + terminated: { + containerID: "containerID_example", + exitCode: 1, + finishedAt: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + signal: 1, + startedAt: new Date('1970-01-01T00:00:00.00Z'), + }, + waiting: { + message: "message_example", + reason: "reason_example", + }, + }, + stopSignal: "stopSignal_example", + user: { + linux: { + gid: 1, + supplementalGroups: [ + 1, + ], + uid: 1, + }, + }, + volumeMounts: [ + { + mountPath: "mountPath_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + }, + ], + }, + ], + message: "message_example", + nominatedNodeName: "nominatedNodeName_example", + observedGeneration: 1, + phase: "phase_example", + podIP: "podIP_example", + podIPs: [ + { + ip: "ip_example", + }, + ], + qosClass: "qosClass_example", + reason: "reason_example", + resize: "resize_example", + resourceClaimStatuses: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + startTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Pod**| | + **name** | [**string**] | name of the Pod | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Pod + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodTemplate + + + +> V1PodTemplate replaceNamespacedPodTemplate(body) + +replace the specified PodTemplate + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedPodTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedPodTemplateRequest = { + // name of the PodTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PodTemplate**| | + **name** | [**string**] | name of the PodTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PodTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicationController + + + +> V1ReplicationController replaceNamespacedReplicationController(body) + +replace the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationController(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicationControllerScale + + + +> V1Scale replaceNamespacedReplicationControllerScale(body) + +replace scale of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationControllerScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicationControllerStatus + + + +> V1ReplicationController replaceNamespacedReplicationControllerStatus(body) + +replace status of the specified ReplicationController + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest = { + // name of the ReplicationController + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + "key": "key_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicationControllerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicationController**| | + **name** | [**string**] | name of the ReplicationController | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicationController + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceQuota + + + +> V1ResourceQuota replaceNamespacedResourceQuota(body) + +replace the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedResourceQuotaRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceQuota(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceQuotaStatus + + + +> V1ResourceQuota replaceNamespacedResourceQuotaStatus(body) + +replace status of the specified ResourceQuota + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest = { + // name of the ResourceQuota + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + hard: { + "key": "key_example", + }, + scopeSelector: { + matchExpressions: [ + { + operator: "operator_example", + scopeName: "scopeName_example", + values: [ + "values_example", + ], + }, + ], + }, + scopes: [ + "scopes_example", + ], + }, + status: { + hard: { + "key": "key_example", + }, + used: { + "key": "key_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceQuotaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceQuota**| | + **name** | [**string**] | name of the ResourceQuota | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceQuota + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedSecret + + + +> V1Secret replaceNamespacedSecret(body) + +replace the specified Secret + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedSecretRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedSecretRequest = { + // name of the Secret + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: { + "key": 'YQ==', + }, + immutable: true, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + stringData: { + "key": "key_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedSecret(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Secret**| | + **name** | [**string**] | name of the Secret | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Secret + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedService + + + +> V1Service replaceNamespacedService(body) + +replace the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedServiceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedService(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedServiceAccount + + + +> V1ServiceAccount replaceNamespacedServiceAccount(body) + +replace the specified ServiceAccount + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedServiceAccountRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceAccountRequest = { + // name of the ServiceAccount + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + automountServiceAccountToken: true, + imagePullSecrets: [ + { + name: "name_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + secrets: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedServiceAccount(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceAccount**| | + **name** | [**string**] | name of the ServiceAccount | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceAccount + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedServiceStatus + + + +> V1Service replaceNamespacedServiceStatus(body) + +replace status of the specified Service + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNamespacedServiceStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNamespacedServiceStatusRequest = { + // name of the Service + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allocateLoadBalancerNodePorts: true, + clusterIP: "clusterIP_example", + clusterIPs: [ + "clusterIPs_example", + ], + externalIPs: [ + "externalIPs_example", + ], + externalName: "externalName_example", + externalTrafficPolicy: "externalTrafficPolicy_example", + healthCheckNodePort: 1, + internalTrafficPolicy: "internalTrafficPolicy_example", + ipFamilies: [ + "ipFamilies_example", + ], + ipFamilyPolicy: "ipFamilyPolicy_example", + loadBalancerClass: "loadBalancerClass_example", + loadBalancerIP: "loadBalancerIP_example", + loadBalancerSourceRanges: [ + "loadBalancerSourceRanges_example", + ], + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + nodePort: 1, + port: 1, + protocol: "protocol_example", + targetPort: "targetPort_example", + }, + ], + publishNotReadyAddresses: true, + selector: { + "key": "key_example", + }, + sessionAffinity: "sessionAffinity_example", + sessionAffinityConfig: { + clientIP: { + timeoutSeconds: 1, + }, + }, + trafficDistribution: "trafficDistribution_example", + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ipMode: "ipMode_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedServiceStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Service**| | + **name** | [**string**] | name of the Service | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Service + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNode + + + +> V1Node replaceNode(body) + +replace the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNodeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNodeRequest = { + // name of the Node + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNodeStatus + + + +> V1Node replaceNodeStatus(body) + +replace status of the specified Node + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplaceNodeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplaceNodeStatusRequest = { + // name of the Node + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + configSource: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + externalID: "externalID_example", + podCIDR: "podCIDR_example", + podCIDRs: [ + "podCIDRs_example", + ], + providerID: "providerID_example", + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + unschedulable: true, + }, + status: { + addresses: [ + { + address: "address_example", + type: "type_example", + }, + ], + allocatable: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + config: { + active: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + assigned: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + error: "error_example", + lastKnownGood: { + configMap: { + kubeletConfigKey: "kubeletConfigKey_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + }, + }, + daemonEndpoints: { + kubeletEndpoint: { + Port: 1, + }, + }, + declaredFeatures: [ + "declaredFeatures_example", + ], + features: { + supplementalGroupsPolicy: true, + }, + images: [ + { + names: [ + "names_example", + ], + sizeBytes: 1, + }, + ], + nodeInfo: { + architecture: "architecture_example", + bootID: "bootID_example", + containerRuntimeVersion: "containerRuntimeVersion_example", + kernelVersion: "kernelVersion_example", + kubeProxyVersion: "kubeProxyVersion_example", + kubeletVersion: "kubeletVersion_example", + machineID: "machineID_example", + operatingSystem: "operatingSystem_example", + osImage: "osImage_example", + swap: { + capacity: 1, + }, + systemUUID: "systemUUID_example", + }, + phase: "phase_example", + runtimeHandlers: [ + { + features: { + recursiveReadOnlyMounts: true, + userNamespaces: true, + }, + name: "name_example", + }, + ], + volumesAttached: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumesInUse: [ + "volumesInUse_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNodeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Node**| | + **name** | [**string**] | name of the Node | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Node + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replacePersistentVolume + + + +> V1PersistentVolume replacePersistentVolume(body) + +replace the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplacePersistentVolumeRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplacePersistentVolumeRequest = { + // name of the PersistentVolume + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePersistentVolume(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replacePersistentVolumeStatus + + + +> V1PersistentVolume replacePersistentVolumeStatus(body) + +replace status of the specified PersistentVolume + +### Example + + +```typescript +import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; +import type { CoreV1ApiReplacePersistentVolumeStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CoreV1Api(configuration); + +const request: CoreV1ApiReplacePersistentVolumeStatusRequest = { + // name of the PersistentVolume + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + secretNamespace: "secretNamespace_example", + shareName: "shareName_example", + }, + capacity: { + "key": "key_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + volumeID: "volumeID_example", + }, + claimRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + csi: { + controllerExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + controllerPublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + driver: "driver_example", + fsType: "fsType_example", + nodeExpandSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodePublishSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + nodeStageSecretRef: { + name: "name_example", + namespace: "namespace_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + volumeHandle: "volumeHandle_example", + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + glusterfs: { + endpoints: "endpoints_example", + endpointsNamespace: "endpointsNamespace_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + targetPortal: "targetPortal_example", + }, + local: { + fsType: "fsType_example", + path: "path_example", + }, + mountOptions: [ + "mountOptions_example", + ], + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + nodeAffinity: { + required: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + namespace: "namespace_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + storageClassName: "storageClassName_example", + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + status: { + lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + phase: "phase_example", + reason: "reason_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePersistentVolumeStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PersistentVolume**| | + **name** | [**string**] | name of the PersistentVolume | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PersistentVolume + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsApi.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsApi.md new file mode 100644 index 00000000000..891d445a1e7 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsApi.md @@ -0,0 +1,62 @@ +--- +id: EventsApi +title: EventsApi +sidebar_label: EventsApi +sidebar_position: 3 +--- +# EventsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/core-resources/EventsApi#getAPIGroup) | **GET** /apis/events.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, EventsApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsV1Api.md new file mode 100644 index 00000000000..fd13c6f99c2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsV1Api.md @@ -0,0 +1,889 @@ +--- +id: EventsV1Api +title: EventsV1Api +sidebar_label: EventsV1Api +sidebar_position: 4 +--- +# EventsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#createNamespacedEvent) | **POST** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**deleteCollectionNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#deleteCollectionNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**deleteNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#deleteNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**getAPIResources**](/docs/api-reference/core-resources/EventsV1Api#getAPIResources) | **GET** /apis/events.k8s.io/v1/ | +[**listEventForAllNamespaces**](/docs/api-reference/core-resources/EventsV1Api#listEventForAllNamespaces) | **GET** /apis/events.k8s.io/v1/events | +[**listNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#listNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events | +[**patchNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#patchNamespacedEvent) | **PATCH** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**readNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#readNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | +[**replaceNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#replaceNamespacedEvent) | **PUT** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | + +### createNamespacedEvent + + + +> EventsV1Event createNamespacedEvent(body) + +create an Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiCreateNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiCreateNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + deprecatedCount: 1, + deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedSource: { + component: "component_example", + host: "host_example", + }, + eventTime: "eventTime_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + note: "note_example", + reason: "reason_example", + regarding: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingController: "reportingController_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **EventsV1Event**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +EventsV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedEvent + + + +> V1Status deleteCollectionNamespacedEvent() + +delete collection of Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiDeleteCollectionNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiDeleteCollectionNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedEvent + + + +> V1Status deleteNamespacedEvent() + +delete an Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiDeleteNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiDeleteNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listEventForAllNamespaces + + + +> EventsV1EventList listEventForAllNamespaces() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiListEventForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiListEventForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEventForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +EventsV1EventList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedEvent + + + +> EventsV1EventList listNamespacedEvent() + +list or watch objects of kind Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiListNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiListNamespacedEventRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +EventsV1EventList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedEvent + + + +> EventsV1Event patchNamespacedEvent(body) + +partially update the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiPatchNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiPatchNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +EventsV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedEvent + + + +> EventsV1Event readNamespacedEvent() + +read the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiReadNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiReadNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +EventsV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedEvent + + + +> EventsV1Event replaceNamespacedEvent(body) + +replace the specified Event + +### Example + + +```typescript +import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; +import type { EventsV1ApiReplaceNamespacedEventRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new EventsV1Api(configuration); + +const request: EventsV1ApiReplaceNamespacedEventRequest = { + // name of the Event + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + action: "action_example", + apiVersion: "apiVersion_example", + deprecatedCount: 1, + deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deprecatedSource: { + component: "component_example", + host: "host_example", + }, + eventTime: "eventTime_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + note: "note_example", + reason: "reason_example", + regarding: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + related: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + reportingController: "reportingController_example", + reportingInstance: "reportingInstance_example", + series: { + count: 1, + lastObservedTime: "lastObservedTime_example", + }, + type: "type_example", + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEvent(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **EventsV1Event**| | + **name** | [**string**] | name of the Event | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +EventsV1Event + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeApi.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeApi.md new file mode 100644 index 00000000000..975a97e8ac4 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeApi.md @@ -0,0 +1,62 @@ +--- +id: NodeApi +title: NodeApi +sidebar_label: NodeApi +sidebar_position: 5 +--- +# NodeApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/core-resources/NodeApi#getAPIGroup) | **GET** /apis/node.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, NodeApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeV1Api.md new file mode 100644 index 00000000000..95f49bda4a8 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeV1Api.md @@ -0,0 +1,751 @@ +--- +id: NodeV1Api +title: NodeV1Api +sidebar_label: NodeV1Api +sidebar_position: 6 +--- +# NodeV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#createRuntimeClass) | **POST** /apis/node.k8s.io/v1/runtimeclasses | +[**deleteCollectionRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#deleteCollectionRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses | +[**deleteRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#deleteRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**getAPIResources**](/docs/api-reference/core-resources/NodeV1Api#getAPIResources) | **GET** /apis/node.k8s.io/v1/ | +[**listRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#listRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses | +[**patchRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#patchRuntimeClass) | **PATCH** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**readRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#readRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses/{name} | +[**replaceRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#replaceRuntimeClass) | **PUT** /apis/node.k8s.io/v1/runtimeclasses/{name} | + +### createRuntimeClass + + + +> V1RuntimeClass createRuntimeClass(body) + +create a RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiCreateRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiCreateRuntimeClassRequest = { + + body: { + apiVersion: "apiVersion_example", + handler: "handler_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + overhead: { + podFixed: { + "key": "key_example", + }, + }, + scheduling: { + nodeSelector: { + "key": "key_example", + }, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RuntimeClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1RuntimeClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionRuntimeClass + + + +> V1Status deleteCollectionRuntimeClass() + +delete collection of RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiDeleteCollectionRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiDeleteCollectionRuntimeClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteRuntimeClass + + + +> V1Status deleteRuntimeClass() + +delete a RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiDeleteRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiDeleteRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listRuntimeClass + + + +> V1RuntimeClassList listRuntimeClass() + +list or watch objects of kind RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiListRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiListRuntimeClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RuntimeClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchRuntimeClass + + + +> V1RuntimeClass patchRuntimeClass(body) + +partially update the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiPatchRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiPatchRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1RuntimeClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readRuntimeClass + + + +> V1RuntimeClass readRuntimeClass() + +read the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiReadRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiReadRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1RuntimeClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceRuntimeClass + + + +> V1RuntimeClass replaceRuntimeClass(body) + +replace the specified RuntimeClass + +### Example + + +```typescript +import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; +import type { NodeV1ApiReplaceRuntimeClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NodeV1Api(configuration); + +const request: NodeV1ApiReplaceRuntimeClassRequest = { + // name of the RuntimeClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + handler: "handler_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + overhead: { + podFixed: { + "key": "key_example", + }, + }, + scheduling: { + nodeSelector: { + "key": "key_example", + }, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceRuntimeClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RuntimeClass**| | + **name** | [**string**] | name of the RuntimeClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1RuntimeClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/core-resources/_category_.json new file mode 100644 index 00000000000..b8f850a4d43 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/core-resources/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Core Resources", + "position": 1 +} diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryApi.md b/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryApi.md new file mode 100644 index 00000000000..ba4ca020e47 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryApi.md @@ -0,0 +1,62 @@ +--- +id: DiscoveryApi +title: DiscoveryApi +sidebar_label: DiscoveryApi +sidebar_position: 1 +--- +# DiscoveryApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/networking/DiscoveryApi#getAPIGroup) | **GET** /apis/discovery.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, DiscoveryApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryV1Api.md new file mode 100644 index 00000000000..d9fcde9ab2f --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryV1Api.md @@ -0,0 +1,913 @@ +--- +id: DiscoveryV1Api +title: DiscoveryV1Api +sidebar_label: DiscoveryV1Api +sidebar_position: 2 +--- +# DiscoveryV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#createNamespacedEndpointSlice) | **POST** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**deleteCollectionNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#deleteCollectionNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**deleteNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#deleteNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**getAPIResources**](/docs/api-reference/networking/DiscoveryV1Api#getAPIResources) | **GET** /apis/discovery.k8s.io/v1/ | +[**listEndpointSliceForAllNamespaces**](/docs/api-reference/networking/DiscoveryV1Api#listEndpointSliceForAllNamespaces) | **GET** /apis/discovery.k8s.io/v1/endpointslices | +[**listNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#listNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | +[**patchNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#patchNamespacedEndpointSlice) | **PATCH** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**readNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#readNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | +[**replaceNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#replaceNamespacedEndpointSlice) | **PUT** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | + +### createNamespacedEndpointSlice + + + +> V1EndpointSlice createNamespacedEndpointSlice(body) + +create an EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiCreateNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiCreateNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + addressType: "addressType_example", + apiVersion: "apiVersion_example", + endpoints: [ + { + addresses: [ + "addresses_example", + ], + conditions: { + ready: true, + serving: true, + terminating: true, + }, + deprecatedTopology: { + "key": "key_example", + }, + hints: { + forNodes: [ + { + name: "name_example", + }, + ], + forZones: [ + { + name: "name_example", + }, + ], + }, + hostname: "hostname_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + zone: "zone_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1EndpointSlice**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1EndpointSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedEndpointSlice + + + +> V1Status deleteCollectionNamespacedEndpointSlice() + +delete collection of EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedEndpointSlice + + + +> V1Status deleteNamespacedEndpointSlice() + +delete an EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listEndpointSliceForAllNamespaces + + + +> V1EndpointSliceList listEndpointSliceForAllNamespaces() + +list or watch objects of kind EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listEndpointSliceForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1EndpointSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedEndpointSlice + + + +> V1EndpointSliceList listNamespacedEndpointSlice() + +list or watch objects of kind EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiListNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiListNamespacedEndpointSliceRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1EndpointSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedEndpointSlice + + + +> V1EndpointSlice patchNamespacedEndpointSlice(body) + +partially update the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiPatchNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiPatchNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1EndpointSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedEndpointSlice + + + +> V1EndpointSlice readNamespacedEndpointSlice() + +read the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiReadNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiReadNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1EndpointSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedEndpointSlice + + + +> V1EndpointSlice replaceNamespacedEndpointSlice(body) + +replace the specified EndpointSlice + +### Example + + +```typescript +import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; +import type { DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new DiscoveryV1Api(configuration); + +const request: DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest = { + // name of the EndpointSlice + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + addressType: "addressType_example", + apiVersion: "apiVersion_example", + endpoints: [ + { + addresses: [ + "addresses_example", + ], + conditions: { + ready: true, + serving: true, + terminating: true, + }, + deprecatedTopology: { + "key": "key_example", + }, + hints: { + forNodes: [ + { + name: "name_example", + }, + ], + forZones: [ + { + name: "name_example", + }, + ], + }, + hostname: "hostname_example", + nodeName: "nodeName_example", + targetRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + zone: "zone_example", + }, + ], + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + ports: [ + { + appProtocol: "appProtocol_example", + name: "name_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedEndpointSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1EndpointSlice**| | + **name** | [**string**] | name of the EndpointSlice | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1EndpointSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingApi.md b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingApi.md new file mode 100644 index 00000000000..47fb65146fa --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingApi.md @@ -0,0 +1,62 @@ +--- +id: NetworkingApi +title: NetworkingApi +sidebar_label: NetworkingApi +sidebar_position: 3 +--- +# NetworkingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/networking/NetworkingApi#getAPIGroup) | **GET** /apis/networking.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, NetworkingApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1Api.md new file mode 100644 index 00000000000..b49013d79f0 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1Api.md @@ -0,0 +1,4552 @@ +--- +id: NetworkingV1Api +title: NetworkingV1Api +sidebar_label: NetworkingV1Api +sidebar_position: 4 +--- +# NetworkingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createIPAddress**](/docs/api-reference/networking/NetworkingV1Api#createIPAddress) | **POST** /apis/networking.k8s.io/v1/ipaddresses | +[**createIngressClass**](/docs/api-reference/networking/NetworkingV1Api#createIngressClass) | **POST** /apis/networking.k8s.io/v1/ingressclasses | +[**createNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#createNamespacedIngress) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**createNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#createNamespacedNetworkPolicy) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**createServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1/servicecidrs | +[**deleteCollectionIPAddress**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses | +[**deleteCollectionIngressClass**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses | +[**deleteCollectionNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**deleteCollectionNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**deleteCollectionServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs | +[**deleteIPAddress**](/docs/api-reference/networking/NetworkingV1Api#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**deleteIngressClass**](/docs/api-reference/networking/NetworkingV1Api#deleteIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**deleteNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#deleteNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**deleteNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#deleteNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**deleteServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**getAPIResources**](/docs/api-reference/networking/NetworkingV1Api#getAPIResources) | **GET** /apis/networking.k8s.io/v1/ | +[**listIPAddress**](/docs/api-reference/networking/NetworkingV1Api#listIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses | +[**listIngressClass**](/docs/api-reference/networking/NetworkingV1Api#listIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses | +[**listIngressForAllNamespaces**](/docs/api-reference/networking/NetworkingV1Api#listIngressForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/ingresses | +[**listNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#listNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | +[**listNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#listNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | +[**listNetworkPolicyForAllNamespaces**](/docs/api-reference/networking/NetworkingV1Api#listNetworkPolicyForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/networkpolicies | +[**listServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs | +[**patchIPAddress**](/docs/api-reference/networking/NetworkingV1Api#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**patchIngressClass**](/docs/api-reference/networking/NetworkingV1Api#patchIngressClass) | **PATCH** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**patchNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedIngress) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**patchNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedIngressStatus) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**patchNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedNetworkPolicy) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**patchServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**patchServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | +[**readIPAddress**](/docs/api-reference/networking/NetworkingV1Api#readIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**readIngressClass**](/docs/api-reference/networking/NetworkingV1Api#readIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**readNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**readNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedIngressStatus) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**readNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**readServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**readServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | +[**replaceIPAddress**](/docs/api-reference/networking/NetworkingV1Api#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1/ipaddresses/{name} | +[**replaceIngressClass**](/docs/api-reference/networking/NetworkingV1Api#replaceIngressClass) | **PUT** /apis/networking.k8s.io/v1/ingressclasses/{name} | +[**replaceNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedIngress) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | +[**replaceNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedIngressStatus) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | +[**replaceNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedNetworkPolicy) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | +[**replaceServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name} | +[**replaceServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | + +### createIPAddress + + + +> V1IPAddress createIPAddress(body) + +create an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateIPAddressRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IPAddress**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createIngressClass + + + +> V1IngressClass createIngressClass(body) + +create an IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateIngressClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controller: "controller_example", + parameters: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + scope: "scope_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IngressClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1IngressClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedIngress + + + +> V1Ingress createNamespacedIngress(body) + +create an Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedNetworkPolicy + + + +> V1NetworkPolicy createNamespacedNetworkPolicy(body) + +create a NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + egress: [ + { + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + to: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + }, + ], + ingress: [ + { + _from: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + }, + ], + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + policyTypes: [ + "policyTypes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1NetworkPolicy**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createServiceCIDR + + + +> V1ServiceCIDR createServiceCIDR(body) + +create a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiCreateServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiCreateServiceCIDRRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionIPAddress + + + +> V1Status deleteCollectionIPAddress() + +delete collection of IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionIngressClass + + + +> V1Status deleteCollectionIngressClass() + +delete collection of IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionIngressClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedIngress + + + +> V1Status deleteCollectionNamespacedIngress() + +delete collection of Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedNetworkPolicy + + + +> V1Status deleteCollectionNamespacedNetworkPolicy() + +delete collection of NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionServiceCIDR + + + +> V1Status deleteCollectionServiceCIDR() + +delete collection of ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteCollectionServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteCollectionServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteIPAddress + + + +> V1Status deleteIPAddress() + +delete an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteIngressClass + + + +> V1Status deleteIngressClass() + +delete an IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteIngressClassRequest = { + // name of the IngressClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedIngress + + + +> V1Status deleteNamespacedIngress() + +delete an Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedNetworkPolicy + + + +> V1Status deleteNamespacedNetworkPolicy() + +delete a NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteServiceCIDR + + + +> V1Status deleteServiceCIDR() + +delete a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiDeleteServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiDeleteServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listIPAddress + + + +> V1IPAddressList listIPAddress() + +list or watch objects of kind IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1IPAddressList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listIngressClass + + + +> V1IngressClassList listIngressClass() + +list or watch objects of kind IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIngressClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1IngressClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listIngressForAllNamespaces + + + +> V1IngressList listIngressForAllNamespaces() + +list or watch objects of kind Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListIngressForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListIngressForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIngressForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1IngressList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedIngress + + + +> V1IngressList listNamespacedIngress() + +list or watch objects of kind Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNamespacedIngressRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1IngressList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedNetworkPolicy + + + +> V1NetworkPolicyList listNamespacedNetworkPolicy() + +list or watch objects of kind NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNamespacedNetworkPolicyRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNetworkPolicyForAllNamespaces + + + +> V1NetworkPolicyList listNetworkPolicyForAllNamespaces() + +list or watch objects of kind NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNetworkPolicyForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicyList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listServiceCIDR + + + +> V1ServiceCIDRList listServiceCIDR() + +list or watch objects of kind ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiListServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiListServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDRList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchIPAddress + + + +> V1IPAddress patchIPAddress(body) + +partially update the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchIngressClass + + + +> V1IngressClass patchIngressClass(body) + +partially update the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchIngressClassRequest = { + // name of the IngressClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1IngressClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedIngress + + + +> V1Ingress patchNamespacedIngress(body) + +partially update the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedIngressStatus + + + +> V1Ingress patchNamespacedIngressStatus(body) + +partially update status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchNamespacedIngressStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedNetworkPolicy + + + +> V1NetworkPolicy patchNamespacedNetworkPolicy(body) + +partially update the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchServiceCIDR + + + +> V1ServiceCIDR patchServiceCIDR(body) + +partially update the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchServiceCIDRStatus + + + +> V1ServiceCIDR patchServiceCIDRStatus(body) + +partially update status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiPatchServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiPatchServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readIPAddress + + + +> V1IPAddress readIPAddress() + +read the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readIngressClass + + + +> V1IngressClass readIngressClass() + +read the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadIngressClassRequest = { + // name of the IngressClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1IngressClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedIngress + + + +> V1Ingress readNamespacedIngress() + +read the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedIngressStatus + + + +> V1Ingress readNamespacedIngressStatus() + +read status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadNamespacedIngressStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedNetworkPolicy + + + +> V1NetworkPolicy readNamespacedNetworkPolicy() + +read the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1NetworkPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readServiceCIDR + + + +> V1ServiceCIDR readServiceCIDR() + +read the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readServiceCIDRStatus + + + +> V1ServiceCIDR readServiceCIDRStatus() + +read status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReadServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReadServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceIPAddress + + + +> V1IPAddress replaceIPAddress(body) + +replace the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IPAddress**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceIngressClass + + + +> V1IngressClass replaceIngressClass(body) + +replace the specified IngressClass + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceIngressClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceIngressClassRequest = { + // name of the IngressClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + controller: "controller_example", + parameters: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + scope: "scope_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIngressClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1IngressClass**| | + **name** | [**string**] | name of the IngressClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1IngressClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedIngress + + + +> V1Ingress replaceNamespacedIngress(body) + +replace the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceNamespacedIngressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedIngressRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedIngress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedIngressStatus + + + +> V1Ingress replaceNamespacedIngressStatus(body) + +replace status of the specified Ingress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceNamespacedIngressStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedIngressStatusRequest = { + // name of the Ingress + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + defaultBackend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + ingressClassName: "ingressClassName_example", + rules: [ + { + host: "host_example", + http: { + paths: [ + { + backend: { + resource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + service: { + name: "name_example", + port: { + name: "name_example", + number: 1, + }, + }, + }, + path: "path_example", + pathType: "pathType_example", + }, + ], + }, + }, + ], + tls: [ + { + hosts: [ + "hosts_example", + ], + secretName: "secretName_example", + }, + ], + }, + status: { + loadBalancer: { + ingress: [ + { + hostname: "hostname_example", + ip: "ip_example", + ports: [ + { + error: "error_example", + port: 1, + protocol: "protocol_example", + }, + ], + }, + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedIngressStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Ingress**| | + **name** | [**string**] | name of the Ingress | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Ingress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedNetworkPolicy + + + +> V1NetworkPolicy replaceNamespacedNetworkPolicy(body) + +replace the specified NetworkPolicy + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest = { + // name of the NetworkPolicy + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + egress: [ + { + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + to: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + }, + ], + ingress: [ + { + _from: [ + { + ipBlock: { + cidr: "cidr_example", + except: [ + "except_example", + ], + }, + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + ], + ports: [ + { + endPort: 1, + port: "port_example", + protocol: "protocol_example", + }, + ], + }, + ], + podSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + policyTypes: [ + "policyTypes_example", + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedNetworkPolicy(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1NetworkPolicy**| | + **name** | [**string**] | name of the NetworkPolicy | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1NetworkPolicy + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceServiceCIDR + + + +> V1ServiceCIDR replaceServiceCIDR(body) + +replace the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceServiceCIDRStatus + + + +> V1ServiceCIDR replaceServiceCIDRStatus(body) + +replace status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; +import type { NetworkingV1ApiReplaceServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1Api(configuration); + +const request: NetworkingV1ApiReplaceServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1beta1Api.md new file mode 100644 index 00000000000..f14ea0a610c --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1beta1Api.md @@ -0,0 +1,1675 @@ +--- +id: NetworkingV1beta1Api +title: NetworkingV1beta1Api +sidebar_label: NetworkingV1beta1Api +sidebar_position: 5 +--- +# NetworkingV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#createIPAddress) | **POST** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**createServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**deleteCollectionIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**deleteCollectionServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**deleteIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**deleteServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**getAPIResources**](/docs/api-reference/networking/NetworkingV1beta1Api#getAPIResources) | **GET** /apis/networking.k8s.io/v1beta1/ | +[**listIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#listIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses | +[**listServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs | +[**patchIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**patchServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**patchServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | +[**readIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#readIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**readServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**readServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | +[**replaceIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | +[**replaceServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | +[**replaceServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | + +### createIPAddress + + + +> V1beta1IPAddress createIPAddress(body) + +create an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiCreateIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiCreateIPAddressRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1IPAddress**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createServiceCIDR + + + +> V1beta1ServiceCIDR createServiceCIDR(body) + +create a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiCreateServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiCreateServiceCIDRRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionIPAddress + + + +> V1Status deleteCollectionIPAddress() + +delete collection of IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiDeleteCollectionIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteCollectionIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionServiceCIDR + + + +> V1Status deleteCollectionServiceCIDR() + +delete collection of ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteIPAddress + + + +> V1Status deleteIPAddress() + +delete an IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiDeleteIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteServiceCIDR + + + +> V1Status deleteServiceCIDR() + +delete a ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiDeleteServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiDeleteServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listIPAddress + + + +> V1beta1IPAddressList listIPAddress() + +list or watch objects of kind IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiListIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiListIPAddressRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1IPAddressList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listServiceCIDR + + + +> V1beta1ServiceCIDRList listServiceCIDR() + +list or watch objects of kind ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiListServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiListServiceCIDRRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDRList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchIPAddress + + + +> V1beta1IPAddress patchIPAddress(body) + +partially update the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiPatchIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchServiceCIDR + + + +> V1beta1ServiceCIDR patchServiceCIDR(body) + +partially update the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiPatchServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchServiceCIDRStatus + + + +> V1beta1ServiceCIDR patchServiceCIDRStatus(body) + +partially update status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiPatchServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiPatchServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readIPAddress + + + +> V1beta1IPAddress readIPAddress() + +read the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReadIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadIPAddressRequest = { + // name of the IPAddress + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readServiceCIDR + + + +> V1beta1ServiceCIDR readServiceCIDR() + +read the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReadServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readServiceCIDRStatus + + + +> V1beta1ServiceCIDR readServiceCIDRStatus() + +read status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReadServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReadServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceIPAddress + + + +> V1beta1IPAddress replaceIPAddress(body) + +replace the specified IPAddress + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReplaceIPAddressRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceIPAddressRequest = { + // name of the IPAddress + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + parentRef: { + group: "group_example", + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceIPAddress(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1IPAddress**| | + **name** | [**string**] | name of the IPAddress | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1IPAddress + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceServiceCIDR + + + +> V1beta1ServiceCIDR replaceServiceCIDR(body) + +replace the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReplaceServiceCIDRRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceServiceCIDRRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDR(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceServiceCIDRStatus + + + +> V1beta1ServiceCIDR replaceServiceCIDRStatus(body) + +replace status of the specified ServiceCIDR + +### Example + + +```typescript +import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; +import type { NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new NetworkingV1beta1Api(configuration); + +const request: NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest = { + // name of the ServiceCIDR + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + cidrs: [ + "cidrs_example", + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceServiceCIDRStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ServiceCIDR**| | + **name** | [**string**] | name of the ServiceCIDR | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ServiceCIDR + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/networking/_category_.json new file mode 100644 index 00000000000..c1c4f2787e3 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/networking/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Networking", + "position": 3 +} diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ApisApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/ApisApi.md new file mode 100644 index 00000000000..966043d77e2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/ApisApi.md @@ -0,0 +1,62 @@ +--- +id: ApisApi +title: ApisApi +sidebar_label: ApisApi +sidebar_position: 1 +--- +# ApisApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIVersions**](/docs/api-reference/other/ApisApi#getAPIVersions) | **GET** /apis/ | + +### getAPIVersions + + + +> V1APIGroupList getAPIVersions() + +get available API versions + +### Example + + +```typescript +import { createConfiguration, ApisApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ApisApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIVersions(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroupList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingApi.md new file mode 100644 index 00000000000..55b0e1d62ba --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingApi.md @@ -0,0 +1,62 @@ +--- +id: AutoscalingApi +title: AutoscalingApi +sidebar_label: AutoscalingApi +sidebar_position: 2 +--- +# AutoscalingApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/other/AutoscalingApi#getAPIGroup) | **GET** /apis/autoscaling/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AutoscalingApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV1Api.md new file mode 100644 index 00000000000..0b0e3e3b682 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV1Api.md @@ -0,0 +1,1125 @@ +--- +id: AutoscalingV1Api +title: AutoscalingV1Api +sidebar_label: AutoscalingV1Api +sidebar_position: 3 +--- +# AutoscalingV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteCollectionNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**getAPIResources**](/docs/api-reference/other/AutoscalingV1Api#getAPIResources) | **GET** /apis/autoscaling/v1/ | +[**listHorizontalPodAutoscalerForAllNamespaces**](/docs/api-reference/other/AutoscalingV1Api#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v1/horizontalpodautoscalers | +[**listNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | +[**patchNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**patchNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**readNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**readNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**replaceNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**replaceNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | + +### createNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) + +create a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedHorizontalPodAutoscaler + + + +> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() + +delete collection of HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedHorizontalPodAutoscaler + + + +> V1Status deleteNamespacedHorizontalPodAutoscaler() + +delete a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listHorizontalPodAutoscalerForAllNamespaces + + + +> V1HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscalerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscalerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) + +partially update the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedHorizontalPodAutoscalerStatus + + + +> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) + +partially update status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() + +read the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedHorizontalPodAutoscalerStatus + + + +> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() + +read status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedHorizontalPodAutoscaler + + + +> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) + +replace the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedHorizontalPodAutoscalerStatus + + + +> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) + +replace status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; +import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV1Api(configuration); + +const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxReplicas: 1, + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + targetCPUUtilizationPercentage: 1, + }, + status: { + currentCPUUtilizationPercentage: 1, + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV2Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV2Api.md new file mode 100644 index 00000000000..95197559ac4 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV2Api.md @@ -0,0 +1,1833 @@ +--- +id: AutoscalingV2Api +title: AutoscalingV2Api +sidebar_label: AutoscalingV2Api +sidebar_position: 4 +--- +# AutoscalingV2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteCollectionNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**deleteNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**getAPIResources**](/docs/api-reference/other/AutoscalingV2Api#getAPIResources) | **GET** /apis/autoscaling/v2/ | +[**listHorizontalPodAutoscalerForAllNamespaces**](/docs/api-reference/other/AutoscalingV2Api#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v2/horizontalpodautoscalers | +[**listNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | +[**patchNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**patchNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**readNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**readNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | +[**replaceNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | +[**replaceNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | + +### createNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) + +create a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedHorizontalPodAutoscaler + + + +> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() + +delete collection of HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedHorizontalPodAutoscaler + + + +> V1Status deleteNamespacedHorizontalPodAutoscaler() + +delete a HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listHorizontalPodAutoscalerForAllNamespaces + + + +> V2HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscalerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() + +list or watch objects of kind HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscalerList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) + +partially update the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedHorizontalPodAutoscalerStatus + + + +> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) + +partially update status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() + +read the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedHorizontalPodAutoscalerStatus + + + +> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() + +read status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedHorizontalPodAutoscaler + + + +> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) + +replace the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedHorizontalPodAutoscalerStatus + + + +> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) + +replace status of the specified HorizontalPodAutoscaler + +### Example + + +```typescript +import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; +import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AutoscalingV2Api(configuration); + +const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { + // name of the HorizontalPodAutoscaler + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + behavior: { + scaleDown: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + scaleUp: { + policies: [ + { + periodSeconds: 1, + type: "type_example", + value: 1, + }, + ], + selectPolicy: "selectPolicy_example", + stabilizationWindowSeconds: 1, + tolerance: "tolerance_example", + }, + }, + maxReplicas: 1, + metrics: [ + { + containerResource: { + container: "container_example", + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + external: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + object: { + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + pods: { + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + resource: { + name: "name_example", + target: { + averageUtilization: 1, + averageValue: "averageValue_example", + type: "type_example", + value: "value_example", + }, + }, + type: "type_example", + }, + ], + minReplicas: 1, + scaleTargetRef: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentMetrics: [ + { + containerResource: { + container: "container_example", + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + external: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + object: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + describedObject: { + apiVersion: "apiVersion_example", + kind: "kind_example", + name: "name_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + pods: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + metric: { + name: "name_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + }, + }, + resource: { + current: { + averageUtilization: 1, + averageValue: "averageValue_example", + value: "value_example", + }, + name: "name_example", + }, + type: "type_example", + }, + ], + currentReplicas: 1, + desiredReplicas: 1, + lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), + observedGeneration: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V2HorizontalPodAutoscaler**| | + **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V2HorizontalPodAutoscaler + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/CustomObjectsApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/CustomObjectsApi.md new file mode 100644 index 00000000000..7b1af985aa2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/CustomObjectsApi.md @@ -0,0 +1,2234 @@ +--- +id: CustomObjectsApi +title: CustomObjectsApi +sidebar_label: CustomObjectsApi +sidebar_position: 5 +--- +# CustomObjectsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#createClusterCustomObject) | **POST** /apis/{group}/{version}/{plural} | +[**createNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#createNamespacedCustomObject) | **POST** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**deleteClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural}/{name} | +[**deleteCollectionClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteCollectionClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural} | +[**deleteCollectionNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteCollectionNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**deleteNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**getAPIResources**](/docs/api-reference/other/CustomObjectsApi#getAPIResources) | **GET** /apis/{group}/{version} | +[**getClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObject) | **GET** /apis/{group}/{version}/{plural}/{name} | +[**getClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObjectScale) | **GET** /apis/{group}/{version}/{plural}/{name}/scale | +[**getClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObjectStatus) | **GET** /apis/{group}/{version}/{plural}/{name}/status | +[**getNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**getNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObjectScale) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**getNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObjectStatus) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | +[**listClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#listClusterCustomObject) | **GET** /apis/{group}/{version}/{plural} | +[**listCustomObjectForAllNamespaces**](/docs/api-reference/other/CustomObjectsApi#listCustomObjectForAllNamespaces) | **GET** /apis/{group}/{version}/{resource_plural} | +[**listNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#listNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural} | +[**patchClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObject) | **PATCH** /apis/{group}/{version}/{plural}/{name} | +[**patchClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObjectScale) | **PATCH** /apis/{group}/{version}/{plural}/{name}/scale | +[**patchClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObjectStatus) | **PATCH** /apis/{group}/{version}/{plural}/{name}/status | +[**patchNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObject) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**patchNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObjectScale) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**patchNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObjectStatus) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | +[**replaceClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObject) | **PUT** /apis/{group}/{version}/{plural}/{name} | +[**replaceClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObjectScale) | **PUT** /apis/{group}/{version}/{plural}/{name}/scale | +[**replaceClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObjectStatus) | **PUT** /apis/{group}/{version}/{plural}/{name}/status | +[**replaceNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObject) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | +[**replaceNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObjectScale) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | +[**replaceNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObjectStatus) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | + +### createClusterCustomObject + + + +> any createClusterCustomObject(body) + +Creates a cluster scoped Custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiCreateClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiCreateClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // The JSON schema of the Resource to create. + body: {}, + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to create. | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**401** | Unauthorized | - | + +### createNamespacedCustomObject + + + +> any createNamespacedCustomObject(body) + +Creates a namespace scoped Custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiCreateNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiCreateNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // The JSON schema of the Resource to create. + body: {}, + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to create. | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**401** | Unauthorized | - | + +### deleteClusterCustomObject + + + +> any deleteClusterCustomObject() + +Deletes the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiDeleteClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterCustomObject + + + +> any deleteCollectionClusterCustomObject() + +Delete collection of cluster scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiDeleteCollectionClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteCollectionClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedCustomObject + + + +> any deleteCollectionNamespacedCustomObject() + +Delete collection of namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedCustomObject + + + +> any deleteNamespacedCustomObject() + +Deletes the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiDeleteNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiDeleteNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) + propagationPolicy: "propagationPolicy_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetAPIResourcesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetAPIResourcesRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", +}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getClusterCustomObject + + + +> any getClusterCustomObject() + +Returns a cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A single Resource | - | +**401** | Unauthorized | - | + +### getClusterCustomObjectScale + + + +> any getClusterCustomObjectScale() + +read scale of the specified custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getClusterCustomObjectStatus + + + +> any getClusterCustomObjectStatus() + +read status of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getNamespacedCustomObject + + + +> any getNamespacedCustomObject() + +Returns a namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A single Resource | - | +**401** | Unauthorized | - | + +### getNamespacedCustomObjectScale + + + +> any getNamespacedCustomObjectScale() + +read scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getNamespacedCustomObjectStatus + + + +> any getNamespacedCustomObjectStatus() + +read status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiGetNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiGetNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", +}; + +const data = await apiInstance.getNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterCustomObject + + + +> any listClusterCustomObject() + +list or watch cluster scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiListClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListClusterCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCustomObjectForAllNamespaces + + + +> any listCustomObjectForAllNamespaces() + +list or watch namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiListCustomObjectForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListCustomObjectForAllNamespacesRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + resourcePlural: "resource_plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listCustomObjectForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **resourcePlural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedCustomObject + + + +> any listNamespacedCustomObject() + +list or watch namespace scoped custom objects + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiListNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiListNamespacedCustomObjectRequest = { + // The custom resource\'s group name + group: "group_example", + // The custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // If \'true\', then the output is pretty printed. (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**string**] | The custom resource\'s group name | defaults to undefined + **version** | [**string**] | The custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/json;stream=watch + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterCustomObject + + + +> any patchClusterCustomObject(body) + +patch the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to patch. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to patch. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterCustomObjectScale + + + +> any patchClusterCustomObjectScale(body) + +partially update scale of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterCustomObjectStatus + + + +> any patchClusterCustomObjectStatus(body) + +partially update status of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedCustomObject + + + +> any patchNamespacedCustomObject(body) + +patch the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to patch. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to patch. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedCustomObjectScale + + + +> any patchNamespacedCustomObjectScale(body) + +partially update scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedCustomObjectStatus + + + +> any patchNamespacedCustomObjectStatus(body) + +partially update status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiPatchNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiPatchNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterCustomObject + + + +> any replaceClusterCustomObject(body) + +replace the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceClusterCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom object\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to replace. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to replace. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterCustomObjectScale + + + +> any replaceClusterCustomObjectScale(body) + +replace scale of the specified cluster scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceClusterCustomObjectStatus + + + +> any replaceClusterCustomObjectStatus(body) + +replace status of the cluster scoped specified custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceClusterCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedCustomObject + + + +> any replaceNamespacedCustomObject(body) + +replace the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceNamespacedCustomObjectRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + // The JSON schema of the Resource to replace. + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObject(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| The JSON schema of the Resource to replace. | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedCustomObjectScale + + + +> any replaceNamespacedCustomObjectScale(body) + +replace scale of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObjectScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedCustomObjectStatus + + + +> any replaceNamespacedCustomObjectStatus(body) + +replace status of the specified namespace scoped custom object + +### Example + + +```typescript +import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; +import type { CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CustomObjectsApi(configuration); + +const request: CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest = { + // the custom resource\'s group + group: "group_example", + // the custom resource\'s version + version: "version_example", + // The custom resource\'s namespace + namespace: "namespace_example", + // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. + plural: "plural_example", + // the custom object\'s name + name: "name_example", + + body: {}, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCustomObjectStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **group** | [**string**] | the custom resource\'s group | defaults to undefined + **version** | [**string**] | the custom resource\'s version | defaults to undefined + **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined + **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined + **name** | [**string**] | the custom object\'s name | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined + +### Return type + +any + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverApi.md new file mode 100644 index 00000000000..41a4b06ea22 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverApi.md @@ -0,0 +1,62 @@ +--- +id: FlowcontrolApiserverApi +title: FlowcontrolApiserverApi +sidebar_label: FlowcontrolApiserverApi +sidebar_position: 6 +--- +# FlowcontrolApiserverApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/other/FlowcontrolApiserverApi#getAPIGroup) | **GET** /apis/flowcontrol.apiserver.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverV1Api.md new file mode 100644 index 00000000000..e4a02865c2d --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverV1Api.md @@ -0,0 +1,2147 @@ +--- +id: FlowcontrolApiserverV1Api +title: FlowcontrolApiserverV1Api +sidebar_label: FlowcontrolApiserverV1Api +sidebar_position: 7 +--- +# FlowcontrolApiserverV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#createFlowSchema) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**createPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#createPriorityLevelConfiguration) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**deleteCollectionFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteCollectionFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**deleteCollectionPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteCollectionPriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**deleteFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**deletePriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deletePriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**getAPIResources**](/docs/api-reference/other/FlowcontrolApiserverV1Api#getAPIResources) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/ | +[**listFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#listFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | +[**listPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#listPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | +[**patchFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchFlowSchema) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**patchFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchFlowSchemaStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**patchPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchPriorityLevelConfiguration) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**patchPriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchPriorityLevelConfigurationStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | +[**readFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**readFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readFlowSchemaStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**readPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**readPriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readPriorityLevelConfigurationStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | +[**replaceFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replaceFlowSchema) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | +[**replaceFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replaceFlowSchemaStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | +[**replacePriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replacePriorityLevelConfiguration) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | +[**replacePriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replacePriorityLevelConfigurationStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | + +### createFlowSchema + + + +> V1FlowSchema createFlowSchema(body) + +create a FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiCreateFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiCreateFlowSchemaRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createPriorityLevelConfiguration + + + +> V1PriorityLevelConfiguration createPriorityLevelConfiguration(body) + +create a PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionFlowSchema + + + +> V1Status deleteCollectionFlowSchema() + +delete collection of FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionPriorityLevelConfiguration + + + +> V1Status deleteCollectionPriorityLevelConfiguration() + +delete collection of PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteFlowSchema + + + +> V1Status deleteFlowSchema() + +delete a FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deletePriorityLevelConfiguration + + + +> V1Status deletePriorityLevelConfiguration() + +delete a PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deletePriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listFlowSchema + + + +> V1FlowSchemaList listFlowSchema() + +list or watch objects of kind FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiListFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiListFlowSchemaRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1FlowSchemaList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPriorityLevelConfiguration + + + +> V1PriorityLevelConfigurationList listPriorityLevelConfiguration() + +list or watch objects of kind PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfigurationList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchFlowSchema + + + +> V1FlowSchema patchFlowSchema(body) + +partially update the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiPatchFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchFlowSchemaStatus + + + +> V1FlowSchema patchFlowSchemaStatus(body) + +partially update status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchPriorityLevelConfiguration + + + +> V1PriorityLevelConfiguration patchPriorityLevelConfiguration(body) + +partially update the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchPriorityLevelConfigurationStatus + + + +> V1PriorityLevelConfiguration patchPriorityLevelConfigurationStatus(body) + +partially update status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchPriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readFlowSchema + + + +> V1FlowSchema readFlowSchema() + +read the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReadFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readFlowSchemaStatus + + + +> V1FlowSchema readFlowSchemaStatus() + +read status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readPriorityLevelConfiguration + + + +> V1PriorityLevelConfiguration readPriorityLevelConfiguration() + +read the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readPriorityLevelConfigurationStatus + + + +> V1PriorityLevelConfiguration readPriorityLevelConfigurationStatus() + +read status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readPriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceFlowSchema + + + +> V1FlowSchema replaceFlowSchema(body) + +replace the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest = { + // name of the FlowSchema + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceFlowSchema(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceFlowSchemaStatus + + + +> V1FlowSchema replaceFlowSchemaStatus(body) + +replace status of the specified FlowSchema + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest = { + // name of the FlowSchema + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + distinguisherMethod: { + type: "type_example", + }, + matchingPrecedence: 1, + priorityLevelConfiguration: { + name: "name_example", + }, + rules: [ + { + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + clusterScope: true, + namespaces: [ + "namespaces_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + subjects: [ + { + group: { + name: "name_example", + }, + kind: "kind_example", + serviceAccount: { + name: "name_example", + namespace: "namespace_example", + }, + user: { + name: "name_example", + }, + }, + ], + }, + ], + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceFlowSchemaStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1FlowSchema**| | + **name** | [**string**] | name of the FlowSchema | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1FlowSchema + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replacePriorityLevelConfiguration + + + +> V1PriorityLevelConfiguration replacePriorityLevelConfiguration(body) + +replace the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityLevelConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replacePriorityLevelConfigurationStatus + + + +> V1PriorityLevelConfiguration replacePriorityLevelConfigurationStatus(body) + +replace status of the specified PriorityLevelConfiguration + +### Example + + +```typescript +import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; +import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new FlowcontrolApiserverV1Api(configuration); + +const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest = { + // name of the PriorityLevelConfiguration + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + exempt: { + lendablePercent: 1, + nominalConcurrencyShares: 1, + }, + limited: { + borrowingLimitPercent: 1, + lendablePercent: 1, + limitResponse: { + queuing: { + handSize: 1, + queueLengthLimit: 1, + queues: 1, + }, + type: "type_example", + }, + nominalConcurrencyShares: 1, + }, + type: "type_example", + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replacePriorityLevelConfigurationStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1PriorityLevelConfiguration**| | + **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1PriorityLevelConfiguration + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverApi.md new file mode 100644 index 00000000000..004c2a11502 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverApi.md @@ -0,0 +1,62 @@ +--- +id: InternalApiserverApi +title: InternalApiserverApi +sidebar_label: InternalApiserverApi +sidebar_position: 8 +--- +# InternalApiserverApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/other/InternalApiserverApi#getAPIGroup) | **GET** /apis/internal.apiserver.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, InternalApiserverApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverV1alpha1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverV1alpha1Api.md new file mode 100644 index 00000000000..dad0d5fc68c --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverV1alpha1Api.md @@ -0,0 +1,1037 @@ +--- +id: InternalApiserverV1alpha1Api +title: InternalApiserverV1alpha1Api +sidebar_label: InternalApiserverV1alpha1Api +sidebar_position: 9 +--- +# InternalApiserverV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#createStorageVersion) | **POST** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**deleteCollectionStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#deleteCollectionStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**deleteStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#deleteStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**getAPIResources**](/docs/api-reference/other/InternalApiserverV1alpha1Api#getAPIResources) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/ | +[**listStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#listStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | +[**patchStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#patchStorageVersion) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**patchStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#patchStorageVersionStatus) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | +[**readStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#readStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**readStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#readStorageVersionStatus) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | +[**replaceStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#replaceStorageVersion) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | +[**replaceStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#replaceStorageVersionStatus) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | + +### createStorageVersion + + + +> V1alpha1StorageVersion createStorageVersion(body) + +create a StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiCreateStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiCreateStorageVersionRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionStorageVersion + + + +> V1Status deleteCollectionStorageVersion() + +delete collection of StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteStorageVersion + + + +> V1Status deleteStorageVersion() + +delete a StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiDeleteStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiDeleteStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listStorageVersion + + + +> V1alpha1StorageVersionList listStorageVersion() + +list or watch objects of kind StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiListStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiListStorageVersionRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersionList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchStorageVersion + + + +> V1alpha1StorageVersion patchStorageVersion(body) + +partially update the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiPatchStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiPatchStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchStorageVersionStatus + + + +> V1alpha1StorageVersion patchStorageVersionStatus(body) + +partially update status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readStorageVersion + + + +> V1alpha1StorageVersion readStorageVersion() + +read the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiReadStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReadStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readStorageVersionStatus + + + +> V1alpha1StorageVersion readStorageVersionStatus() + +read status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceStorageVersion + + + +> V1alpha1StorageVersion replaceStorageVersion(body) + +replace the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiReplaceStorageVersionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReplaceStorageVersionRequest = { + // name of the StorageVersion + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersion(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceStorageVersionStatus + + + +> V1alpha1StorageVersion replaceStorageVersionStatus(body) + +replace status of the specified StorageVersion + +### Example + + +```typescript +import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; +import type { InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new InternalApiserverV1alpha1Api(configuration); + +const request: InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest = { + // name of the StorageVersion + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: {}, + status: { + commonEncodingVersion: "commonEncodingVersion_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + storageVersions: [ + { + apiServerID: "apiServerID_example", + decodableVersions: [ + "decodableVersions_example", + ], + encodingVersion: "encodingVersion_example", + servedVersions: [ + "servedVersions_example", + ], + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceStorageVersionStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1StorageVersion**| | + **name** | [**string**] | name of the StorageVersion | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1StorageVersion + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/LogsApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/LogsApi.md new file mode 100644 index 00000000000..6b4953a3eea --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/LogsApi.md @@ -0,0 +1,111 @@ +--- +id: LogsApi +title: LogsApi +sidebar_label: LogsApi +sidebar_position: 10 +--- +# LogsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**logFileHandler**](/docs/api-reference/other/LogsApi#logFileHandler) | **GET** /logs/{logpath} | +[**logFileListHandler**](/docs/api-reference/other/LogsApi#logFileListHandler) | **GET** /logs/ | + +### logFileHandler + + + +> logFileHandler() + +### Example + + +```typescript +import { createConfiguration, LogsApi } from '@kubernetes/client-node'; +import type { LogsApiLogFileHandlerRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new LogsApi(configuration); + +const request: LogsApiLogFileHandlerRequest = { + // path to the log + logpath: "logpath_example", +}; + +const data = await apiInstance.logFileHandler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **logpath** | [**string**] | path to the log | defaults to undefined + +### Return type + +void (empty response body) + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**401** | Unauthorized | - | + +### logFileListHandler + + + +> logFileListHandler() + +### Example + + +```typescript +import { createConfiguration, LogsApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new LogsApi(configuration); + +const request = {}; + +const data = await apiInstance.logFileListHandler(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/OpenidApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/OpenidApi.md new file mode 100644 index 00000000000..7c54bab7421 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/OpenidApi.md @@ -0,0 +1,62 @@ +--- +id: OpenidApi +title: OpenidApi +sidebar_label: OpenidApi +sidebar_position: 11 +--- +# OpenidApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getServiceAccountIssuerOpenIDKeyset**](/docs/api-reference/other/OpenidApi#getServiceAccountIssuerOpenIDKeyset) | **GET** /openid/v1/jwks | + +### getServiceAccountIssuerOpenIDKeyset + + + +> string getServiceAccountIssuerOpenIDKeyset() + +get service account issuer OpenID JSON Web Key Set (contains public token verification keys) + +### Example + + +```typescript +import { createConfiguration, OpenidApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new OpenidApi(configuration); + +const request = {}; + +const data = await apiInstance.getServiceAccountIssuerOpenIDKeyset(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/jwk-set+json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceApi.md new file mode 100644 index 00000000000..4f03d6331c3 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceApi.md @@ -0,0 +1,62 @@ +--- +id: ResourceApi +title: ResourceApi +sidebar_label: ResourceApi +sidebar_position: 12 +--- +# ResourceApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/other/ResourceApi#getAPIGroup) | **GET** /apis/resource.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, ResourceApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1Api.md new file mode 100644 index 00000000000..f5608ee68dc --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1Api.md @@ -0,0 +1,4243 @@ +--- +id: ResourceV1Api +title: ResourceV1Api +sidebar_label: ResourceV1Api +sidebar_position: 14 +--- +# ResourceV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](/docs/api-reference/other/ResourceV1Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1/deviceclasses | +[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](/docs/api-reference/other/ResourceV1Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1/resourceslices | +[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices | +[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**getAPIResources**](/docs/api-reference/other/ResourceV1Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1/ | +[**listDeviceClass**](/docs/api-reference/other/ResourceV1Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses | +[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaimtemplates | +[**listResourceSlice**](/docs/api-reference/other/ResourceV1Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices | +[**patchDeviceClass**](/docs/api-reference/other/ResourceV1Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](/docs/api-reference/other/ResourceV1Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**readDeviceClass**](/docs/api-reference/other/ResourceV1Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](/docs/api-reference/other/ResourceV1Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices/{name} | +[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1/resourceslices/{name} | + +### createDeviceClass + + + +> V1DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaim + + + +> ResourceV1ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createResourceSlice + + + +> V1ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionDeviceClass + + + +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaim + + + +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaimTemplate + + + +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionResourceSlice + + + +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteDeviceClass + + + +> V1DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaim + + + +> ResourceV1ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteResourceSlice + + + +> V1ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeviceClass + + + +> V1DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DeviceClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaim + + + +> V1ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimForAllNamespaces + + + +> V1ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimTemplateForAllNamespaces + + + +> V1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceSlice + + + +> V1ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiListResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ResourceSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchDeviceClass + + + +> V1DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaim + + + +> ResourceV1ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimStatus + + + +> ResourceV1ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchResourceSlice + + + +> V1ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readDeviceClass + + + +> V1DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaim + + + +> ResourceV1ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimStatus + + + +> ResourceV1ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readResourceSlice + + + +> V1ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReadResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceDeviceClass + + + +> V1DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaim + + + +> ResourceV1ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimStatus + + + +> ResourceV1ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **ResourceV1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +ResourceV1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimTemplate + + + +> V1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceResourceSlice + + + +> V1ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; +import type { ResourceV1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1Api(configuration); + +const request: ResourceV1ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1alpha3Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1alpha3Api.md new file mode 100644 index 00000000000..422afac65e5 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1alpha3Api.md @@ -0,0 +1,1034 @@ +--- +id: ResourceV1alpha3Api +title: ResourceV1alpha3Api +sidebar_label: ResourceV1alpha3Api +sidebar_position: 13 +--- +# ResourceV1alpha3Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#createDeviceTaintRule) | **POST** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**deleteCollectionDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#deleteCollectionDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**deleteDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#deleteDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**getAPIResources**](/docs/api-reference/other/ResourceV1alpha3Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1alpha3/ | +[**listDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#listDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules | +[**patchDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#patchDeviceTaintRule) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**patchDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#patchDeviceTaintRuleStatus) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | +[**readDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#readDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**readDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#readDeviceTaintRuleStatus) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | +[**replaceDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#replaceDeviceTaintRule) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | +[**replaceDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#replaceDeviceTaintRuleStatus) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | + +### createDeviceTaintRule + + + +> V1alpha3DeviceTaintRule createDeviceTaintRule(body) + +create a DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiCreateDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiCreateDeviceTaintRuleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionDeviceTaintRule + + + +> V1Status deleteCollectionDeviceTaintRule() + +delete collection of DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteDeviceTaintRule + + + +> V1alpha3DeviceTaintRule deleteDeviceTaintRule() + +delete a DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeviceTaintRule + + + +> V1alpha3DeviceTaintRuleList listDeviceTaintRule() + +list or watch objects of kind DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiListDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiListDeviceTaintRuleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRuleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchDeviceTaintRule + + + +> V1alpha3DeviceTaintRule patchDeviceTaintRule(body) + +partially update the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiPatchDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiPatchDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchDeviceTaintRuleStatus + + + +> V1alpha3DeviceTaintRule patchDeviceTaintRuleStatus(body) + +partially update status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readDeviceTaintRule + + + +> V1alpha3DeviceTaintRule readDeviceTaintRule() + +read the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiReadDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReadDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readDeviceTaintRuleStatus + + + +> V1alpha3DeviceTaintRule readDeviceTaintRuleStatus() + +read status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceDeviceTaintRule + + + +> V1alpha3DeviceTaintRule replaceDeviceTaintRule(body) + +replace the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceTaintRule(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceDeviceTaintRuleStatus + + + +> V1alpha3DeviceTaintRule replaceDeviceTaintRuleStatus(body) + +replace status of the specified DeviceTaintRule + +### Example + + +```typescript +import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; +import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1alpha3Api(configuration); + +const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest = { + // name of the DeviceTaintRule + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + deviceSelector: { + device: "device_example", + driver: "driver_example", + pool: "pool_example", + }, + taint: { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + }, + status: { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceTaintRuleStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha3DeviceTaintRule**| | + **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha3DeviceTaintRule + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta1Api.md new file mode 100644 index 00000000000..45b5addc503 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta1Api.md @@ -0,0 +1,4237 @@ +--- +id: ResourceV1beta1Api +title: ResourceV1beta1Api +sidebar_label: ResourceV1beta1Api +sidebar_position: 15 +--- +# ResourceV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta1/resourceslices | +[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices | +[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**getAPIResources**](/docs/api-reference/other/ResourceV1beta1Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta1/ | +[**listDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses | +[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1beta1Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1beta1Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaimtemplates | +[**listResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices | +[**patchDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**readDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | +[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | + +### createDeviceClass + + + +> V1beta1DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaim + + + +> V1beta1ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createResourceSlice + + + +> V1beta1ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + basic: { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + name: "name_example", + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionDeviceClass + + + +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaim + + + +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaimTemplate + + + +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionResourceSlice + + + +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteDeviceClass + + + +> V1beta1DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaim + + + +> V1beta1ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteResourceSlice + + + +> V1beta1ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeviceClass + + + +> V1beta1DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaim + + + +> V1beta1ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimForAllNamespaces + + + +> V1beta1ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimTemplateForAllNamespaces + + + +> V1beta1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceSlice + + + +> V1beta1ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiListResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchDeviceClass + + + +> V1beta1DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaim + + + +> V1beta1ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimStatus + + + +> V1beta1ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchResourceSlice + + + +> V1beta1ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readDeviceClass + + + +> V1beta1DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaim + + + +> V1beta1ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimStatus + + + +> V1beta1ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readResourceSlice + + + +> V1beta1ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReadResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceDeviceClass + + + +> V1beta1DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaim + + + +> V1beta1ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimStatus + + + +> V1beta1ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimTemplate + + + +> V1beta1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceResourceSlice + + + +> V1beta1ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; +import type { ResourceV1beta1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta1Api(configuration); + +const request: ResourceV1beta1ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + basic: { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + name: "name_example", + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta2Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta2Api.md new file mode 100644 index 00000000000..63718ec328b --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta2Api.md @@ -0,0 +1,4243 @@ +--- +id: ResourceV1beta2Api +title: ResourceV1beta2Api +sidebar_label: ResourceV1beta2Api +sidebar_position: 16 +--- +# ResourceV1beta2Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**createResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta2/resourceslices | +[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices | +[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**getAPIResources**](/docs/api-reference/other/ResourceV1beta2Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta2/ | +[**listDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses | +[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | +[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | +[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1beta2Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaims | +[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1beta2Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaimtemplates | +[**listResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices | +[**patchDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**patchResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**readDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**readResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | +[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | +[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | +[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | +[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | +[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | + +### createDeviceClass + + + +> V1beta2DeviceClass createDeviceClass(body) + +create a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateDeviceClassRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2DeviceClass**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaim + + + +> V1beta2ResourceClaim createNamespacedResourceClaim(body) + +create a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) + +create a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaimTemplate**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createResourceSlice + + + +> V1beta2ResourceSlice createResourceSlice(body) + +create a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiCreateResourceSliceRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceSlice**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionDeviceClass + + + +> V1Status deleteCollectionDeviceClass() + +delete collection of DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaim + + + +> V1Status deleteCollectionNamespacedResourceClaim() + +delete collection of ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedResourceClaimTemplate + + + +> V1Status deleteCollectionNamespacedResourceClaimTemplate() + +delete collection of ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionResourceSlice + + + +> V1Status deleteCollectionResourceSlice() + +delete collection of ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteCollectionResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteDeviceClass + + + +> V1beta2DeviceClass deleteDeviceClass() + +delete a DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaim + + + +> V1beta2ResourceClaim deleteNamespacedResourceClaim() + +delete a ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() + +delete a ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteResourceSlice + + + +> V1beta2ResourceSlice deleteResourceSlice() + +delete a ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiDeleteResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeviceClass + + + +> V1beta2DeviceClassList listDeviceClass() + +list or watch objects of kind DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListDeviceClassRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClassList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaim + + + +> V1beta2ResourceClaimList listNamespacedResourceClaim() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListNamespacedResourceClaimRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplateList listNamespacedResourceClaimTemplate() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimForAllNamespaces + + + +> V1beta2ResourceClaimList listResourceClaimForAllNamespaces() + +list or watch objects of kind ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceClaimTemplateForAllNamespaces + + + +> V1beta2ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() + +list or watch objects of kind ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplateList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listResourceSlice + + + +> V1beta2ResourceSliceList listResourceSlice() + +list or watch objects of kind ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiListResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiListResourceSliceRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSliceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchDeviceClass + + + +> V1beta2DeviceClass patchDeviceClass(body) + +partially update the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaim + + + +> V1beta2ResourceClaim patchNamespacedResourceClaim(body) + +partially update the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimStatus + + + +> V1beta2ResourceClaim patchNamespacedResourceClaimStatus(body) + +partially update status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) + +partially update the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchResourceSlice + + + +> V1beta2ResourceSlice patchResourceSlice(body) + +partially update the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiPatchResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readDeviceClass + + + +> V1beta2DeviceClass readDeviceClass() + +read the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaim + + + +> V1beta2ResourceClaim readNamespacedResourceClaim() + +read the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimStatus + + + +> V1beta2ResourceClaim readNamespacedResourceClaimStatus() + +read status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate readNamespacedResourceClaimTemplate() + +read the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readResourceSlice + + + +> V1beta2ResourceSlice readResourceSlice() + +read the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReadResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReadResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceDeviceClass + + + +> V1beta2DeviceClass replaceDeviceClass(body) + +replace the specified DeviceClass + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceDeviceClassRequest = { + // name of the DeviceClass + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + }, + ], + extendedResourceName: "extendedResourceName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceDeviceClass(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2DeviceClass**| | + **name** | [**string**] | name of the DeviceClass | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2DeviceClass + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaim + + + +> V1beta2ResourceClaim replaceNamespacedResourceClaim(body) + +replace the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaim(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimStatus + + + +> V1beta2ResourceClaim replaceNamespacedResourceClaimStatus(body) + +replace status of the specified ResourceClaim + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest = { + // name of the ResourceClaim + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + status: { + allocation: { + allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + source: "source_example", + }, + ], + results: [ + { + adminAccess: true, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + consumedCapacity: { + "key": "key_example", + }, + device: "device_example", + driver: "driver_example", + pool: "pool_example", + request: "request_example", + shareID: "shareID_example", + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + }, + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + devices: [ + { + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + data: {}, + device: "device_example", + driver: "driver_example", + networkData: { + hardwareAddress: "hardwareAddress_example", + interfaceName: "interfaceName_example", + ips: [ + "ips_example", + ], + }, + pool: "pool_example", + shareID: "shareID_example", + }, + ], + reservedFor: [ + { + apiGroup: "apiGroup_example", + name: "name_example", + resource: "resource_example", + uid: "uid_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaim**| | + **name** | [**string**] | name of the ResourceClaim | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaim + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedResourceClaimTemplate + + + +> V1beta2ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) + +replace the specified ResourceClaimTemplate + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest = { + // name of the ResourceClaimTemplate + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + devices: { + config: [ + { + opaque: { + driver: "driver_example", + parameters: {}, + }, + requests: [ + "requests_example", + ], + }, + ], + constraints: [ + { + distinctAttribute: "distinctAttribute_example", + matchAttribute: "matchAttribute_example", + requests: [ + "requests_example", + ], + }, + ], + requests: [ + { + exactly: { + adminAccess: true, + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + firstAvailable: [ + { + allocationMode: "allocationMode_example", + capacity: { + requests: { + "key": "key_example", + }, + }, + count: 1, + deviceClassName: "deviceClassName_example", + name: "name_example", + selectors: [ + { + cel: { + expression: "expression_example", + }, + }, + ], + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + }, + ], + name: "name_example", + }, + ], + }, + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceClaimTemplate**| | + **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceClaimTemplate + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceResourceSlice + + + +> V1beta2ResourceSlice replaceResourceSlice(body) + +replace the specified ResourceSlice + +### Example + + +```typescript +import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; +import type { ResourceV1beta2ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new ResourceV1beta2Api(configuration); + +const request: ResourceV1beta2ApiReplaceResourceSliceRequest = { + // name of the ResourceSlice + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + allNodes: true, + devices: [ + { + allNodes: true, + allowMultipleAllocations: true, + attributes: { + "key": { + bool: true, + _int: 1, + string: "string_example", + version: "version_example", + }, + }, + bindingConditions: [ + "bindingConditions_example", + ], + bindingFailureConditions: [ + "bindingFailureConditions_example", + ], + bindsToNode: true, + capacity: { + "key": { + requestPolicy: { + _default: "_default_example", + validRange: { + max: "max_example", + min: "min_example", + step: "step_example", + }, + validValues: [ + "validValues_example", + ], + }, + value: "value_example", + }, + }, + consumesCounters: [ + { + counterSet: "counterSet_example", + counters: { + "key": { + value: "value_example", + }, + }, + }, + ], + name: "name_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + taints: [ + { + effect: "effect_example", + key: "key_example", + timeAdded: new Date('1970-01-01T00:00:00.00Z'), + value: "value_example", + }, + ], + }, + ], + driver: "driver_example", + nodeName: "nodeName_example", + nodeSelector: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + perDeviceNodeSelection: true, + pool: { + generation: 1, + name: "name_example", + resourceSliceCount: 1, + }, + sharedCounters: [ + { + counters: { + "key": { + value: "value_example", + }, + }, + name: "name_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceResourceSlice(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta2ResourceSlice**| | + **name** | [**string**] | name of the ResourceSlice | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta2ResourceSlice + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/VersionApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/VersionApi.md new file mode 100644 index 00000000000..4bcec0125a1 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/VersionApi.md @@ -0,0 +1,62 @@ +--- +id: VersionApi +title: VersionApi +sidebar_label: VersionApi +sidebar_position: 17 +--- +# VersionApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getCode**](/docs/api-reference/other/VersionApi#getCode) | **GET** /version/ | + +### getCode + + + +> VersionInfo getCode() + +get the version information for this server + +### Example + + +```typescript +import { createConfiguration, VersionApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new VersionApi(configuration); + +const request = {}; + +const data = await apiInstance.getCode(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +VersionInfo + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/WellKnownApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/WellKnownApi.md new file mode 100644 index 00000000000..e3550313146 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/WellKnownApi.md @@ -0,0 +1,62 @@ +--- +id: WellKnownApi +title: WellKnownApi +sidebar_label: WellKnownApi +sidebar_position: 18 +--- +# WellKnownApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getServiceAccountIssuerOpenIDConfiguration**](/docs/api-reference/other/WellKnownApi#getServiceAccountIssuerOpenIDConfiguration) | **GET** /.well-known/openid-configuration | + +### getServiceAccountIssuerOpenIDConfiguration + + + +> string getServiceAccountIssuerOpenIDConfiguration() + +get service account issuer OpenID configuration, also known as the \'OIDC discovery doc\' + +### Example + + +```typescript +import { createConfiguration, WellKnownApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new WellKnownApi(configuration); + +const request = {}; + +const data = await apiInstance.getServiceAccountIssuerOpenIDConfiguration(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +string + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/other/_category_.json new file mode 100644 index 00000000000..ea3276e897e --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/other/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Other", + "position": 7 +} diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationApi.md b/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationApi.md new file mode 100644 index 00000000000..87462a1c002 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationApi.md @@ -0,0 +1,62 @@ +--- +id: AuthenticationApi +title: AuthenticationApi +sidebar_label: AuthenticationApi +sidebar_position: 1 +--- +# AuthenticationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/security/AuthenticationApi#getAPIGroup) | **GET** /apis/authentication.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AuthenticationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationV1Api.md new file mode 100644 index 00000000000..ea08df6db06 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationV1Api.md @@ -0,0 +1,329 @@ +--- +id: AuthenticationV1Api +title: AuthenticationV1Api +sidebar_label: AuthenticationV1Api +sidebar_position: 2 +--- +# AuthenticationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createSelfSubjectReview**](/docs/api-reference/security/AuthenticationV1Api#createSelfSubjectReview) | **POST** /apis/authentication.k8s.io/v1/selfsubjectreviews | +[**createTokenReview**](/docs/api-reference/security/AuthenticationV1Api#createTokenReview) | **POST** /apis/authentication.k8s.io/v1/tokenreviews | +[**getAPIResources**](/docs/api-reference/security/AuthenticationV1Api#getAPIResources) | **GET** /apis/authentication.k8s.io/v1/ | + +### createSelfSubjectReview + + + +> V1SelfSubjectReview createSelfSubjectReview(body) + +create a SelfSubjectReview + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; +import type { AuthenticationV1ApiCreateSelfSubjectReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request: AuthenticationV1ApiCreateSelfSubjectReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + status: { + userInfo: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + uid: "uid_example", + username: "username_example", + }, + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1SelfSubjectReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createTokenReview + + + +> V1TokenReview createTokenReview(body) + +create a TokenReview + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; +import type { AuthenticationV1ApiCreateTokenReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request: AuthenticationV1ApiCreateTokenReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + audiences: [ + "audiences_example", + ], + token: "token_example", + }, + status: { + audiences: [ + "audiences_example", + ], + authenticated: true, + error: "error_example", + user: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + uid: "uid_example", + username: "username_example", + }, + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createTokenReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1TokenReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1TokenReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthenticationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationApi.md b/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationApi.md new file mode 100644 index 00000000000..8a455c1507a --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationApi.md @@ -0,0 +1,62 @@ +--- +id: AuthorizationApi +title: AuthorizationApi +sidebar_label: AuthorizationApi +sidebar_position: 3 +--- +# AuthorizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/security/AuthorizationApi#getAPIGroup) | **GET** /apis/authorization.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AuthorizationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationV1Api.md new file mode 100644 index 00000000000..f93a906688b --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationV1Api.md @@ -0,0 +1,709 @@ +--- +id: AuthorizationV1Api +title: AuthorizationV1Api +sidebar_label: AuthorizationV1Api +sidebar_position: 4 +--- +# AuthorizationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedLocalSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createNamespacedLocalSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews | +[**createSelfSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createSelfSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectaccessreviews | +[**createSelfSubjectRulesReview**](/docs/api-reference/security/AuthorizationV1Api#createSelfSubjectRulesReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectrulesreviews | +[**createSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/subjectaccessreviews | +[**getAPIResources**](/docs/api-reference/security/AuthorizationV1Api#getAPIResources) | **GET** /apis/authorization.k8s.io/v1/ | + +### createNamespacedLocalSubjectAccessReview + + + +> V1LocalSubjectAccessReview createNamespacedLocalSubjectAccessReview(body) + +create a LocalSubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; +import type { AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + uid: "uid_example", + user: "user_example", + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createNamespacedLocalSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1LocalSubjectAccessReview**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1LocalSubjectAccessReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createSelfSubjectAccessReview + + + +> V1SelfSubjectAccessReview createSelfSubjectAccessReview(body) + +create a SelfSubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; +import type { AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectAccessReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1SelfSubjectAccessReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createSelfSubjectRulesReview + + + +> V1SelfSubjectRulesReview createSelfSubjectRulesReview(body) + +create a SelfSubjectRulesReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; +import type { AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + namespace: "namespace_example", + }, + status: { + evaluationError: "evaluationError_example", + incomplete: true, + nonResourceRules: [ + { + nonResourceURLs: [ + "nonResourceURLs_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + resourceRules: [ + { + apiGroups: [ + "apiGroups_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSelfSubjectRulesReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SelfSubjectRulesReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1SelfSubjectRulesReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createSubjectAccessReview + + + +> V1SubjectAccessReview createSubjectAccessReview(body) + +create a SubjectAccessReview + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; +import type { AuthorizationV1ApiCreateSubjectAccessReviewRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request: AuthorizationV1ApiCreateSubjectAccessReviewRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + nonResourceAttributes: { + path: "path_example", + verb: "verb_example", + }, + resourceAttributes: { + fieldSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + group: "group_example", + labelSelector: { + rawSelector: "rawSelector_example", + requirements: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + name: "name_example", + namespace: "namespace_example", + resource: "resource_example", + subresource: "subresource_example", + verb: "verb_example", + version: "version_example", + }, + uid: "uid_example", + user: "user_example", + }, + status: { + allowed: true, + denied: true, + evaluationError: "evaluationError_example", + reason: "reason_example", + }, + }, + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.createSubjectAccessReview(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1SubjectAccessReview**| | + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1SubjectAccessReview + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AuthorizationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesApi.md b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesApi.md new file mode 100644 index 00000000000..64655347e16 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesApi.md @@ -0,0 +1,62 @@ +--- +id: CertificatesApi +title: CertificatesApi +sidebar_label: CertificatesApi +sidebar_position: 5 +--- +# CertificatesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/security/CertificatesApi#getAPIGroup) | **GET** /apis/certificates.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, CertificatesApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1Api.md new file mode 100644 index 00000000000..115c9de03cb --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1Api.md @@ -0,0 +1,1331 @@ +--- +id: CertificatesV1Api +title: CertificatesV1Api +sidebar_label: CertificatesV1Api +sidebar_position: 7 +--- +# CertificatesV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#createCertificateSigningRequest) | **POST** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**deleteCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#deleteCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**deleteCollectionCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#deleteCollectionCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**getAPIResources**](/docs/api-reference/security/CertificatesV1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1/ | +[**listCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#listCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests | +[**patchCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequest) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**patchCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequestApproval) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**patchCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | +[**readCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**readCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequestApproval) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**readCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequestStatus) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | +[**replaceCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequest) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | +[**replaceCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequestApproval) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | +[**replaceCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequestStatus) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | + +### createCertificateSigningRequest + + + +> V1CertificateSigningRequest createCertificateSigningRequest(body) + +create a CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiCreateCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiCreateCertificateSigningRequestRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCertificateSigningRequest + + + +> V1Status deleteCertificateSigningRequest() + +delete a CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiDeleteCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiDeleteCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionCertificateSigningRequest + + + +> V1Status deleteCollectionCertificateSigningRequest() + +delete collection of CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCertificateSigningRequest + + + +> V1CertificateSigningRequestList listCertificateSigningRequest() + +list or watch objects of kind CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiListCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiListCertificateSigningRequestRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequestList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchCertificateSigningRequest + + + +> V1CertificateSigningRequest patchCertificateSigningRequest(body) + +partially update the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiPatchCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchCertificateSigningRequestApproval + + + +> V1CertificateSigningRequest patchCertificateSigningRequestApproval(body) + +partially update approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchCertificateSigningRequestStatus + + + +> V1CertificateSigningRequest patchCertificateSigningRequestStatus(body) + +partially update status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiPatchCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiPatchCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readCertificateSigningRequest + + + +> V1CertificateSigningRequest readCertificateSigningRequest() + +read the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReadCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readCertificateSigningRequestApproval + + + +> V1CertificateSigningRequest readCertificateSigningRequestApproval() + +read approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReadCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readCertificateSigningRequestStatus + + + +> V1CertificateSigningRequest readCertificateSigningRequestStatus() + +read status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReadCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReadCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceCertificateSigningRequest + + + +> V1CertificateSigningRequest replaceCertificateSigningRequest(body) + +replace the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReplaceCertificateSigningRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceCertificateSigningRequestApproval + + + +> V1CertificateSigningRequest replaceCertificateSigningRequestApproval(body) + +replace approval of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequestApproval(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceCertificateSigningRequestStatus + + + +> V1CertificateSigningRequest replaceCertificateSigningRequestStatus(body) + +replace status of the specified CertificateSigningRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; +import type { CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1Api(configuration); + +const request: CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest = { + // name of the CertificateSigningRequest + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + expirationSeconds: 1, + extra: { + "key": [ + "key_example", + ], + }, + groups: [ + "groups_example", + ], + request: 'YQ==', + signerName: "signerName_example", + uid: "uid_example", + usages: [ + "usages_example", + ], + username: "username_example", + }, + status: { + certificate: 'YQ==', + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceCertificateSigningRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CertificateSigningRequest**| | + **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CertificateSigningRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1alpha1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1alpha1Api.md new file mode 100644 index 00000000000..3d8fd7a66b4 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1alpha1Api.md @@ -0,0 +1,719 @@ +--- +id: CertificatesV1alpha1Api +title: CertificatesV1alpha1Api +sidebar_label: CertificatesV1alpha1Api +sidebar_position: 6 +--- +# CertificatesV1alpha1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**deleteClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**deleteCollectionClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**getAPIResources**](/docs/api-reference/security/CertificatesV1alpha1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1alpha1/ | +[**listClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | +[**patchClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**readClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | +[**replaceClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | + +### createClusterTrustBundle + + + +> V1alpha1ClusterTrustBundle createClusterTrustBundle(body) + +create a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiCreateClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiCreateClusterTrustBundleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1ClusterTrustBundle**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteClusterTrustBundle + + + +> V1Status deleteClusterTrustBundle() + +delete a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterTrustBundle + + + +> V1Status deleteCollectionClusterTrustBundle() + +delete collection of ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterTrustBundle + + + +> V1alpha1ClusterTrustBundleList listClusterTrustBundle() + +list or watch objects of kind ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiListClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiListClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterTrustBundle + + + +> V1alpha1ClusterTrustBundle patchClusterTrustBundle(body) + +partially update the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiPatchClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiPatchClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readClusterTrustBundle + + + +> V1alpha1ClusterTrustBundle readClusterTrustBundle() + +read the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiReadClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiReadClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterTrustBundle + + + +> V1alpha1ClusterTrustBundle replaceClusterTrustBundle(body) + +replace the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; +import type { CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1alpha1Api(configuration); + +const request: CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1alpha1ClusterTrustBundle**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1alpha1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1beta1Api.md new file mode 100644 index 00000000000..5cef2659fca --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1beta1Api.md @@ -0,0 +1,1824 @@ +--- +id: CertificatesV1beta1Api +title: CertificatesV1beta1Api +sidebar_label: CertificatesV1beta1Api +sidebar_position: 8 +--- +# CertificatesV1beta1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**createNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#createNamespacedPodCertificateRequest) | **POST** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**deleteClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**deleteCollectionClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**deleteCollectionNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#deleteCollectionNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**deleteNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#deleteNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**getAPIResources**](/docs/api-reference/security/CertificatesV1beta1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1beta1/ | +[**listClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | +[**listNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#listNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | +[**listPodCertificateRequestForAllNamespaces**](/docs/api-reference/security/CertificatesV1beta1Api#listPodCertificateRequestForAllNamespaces) | **GET** /apis/certificates.k8s.io/v1beta1/podcertificaterequests | +[**patchClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**patchNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#patchNamespacedPodCertificateRequest) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**patchNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#patchNamespacedPodCertificateRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | +[**readClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**readNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#readNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**readNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#readNamespacedPodCertificateRequestStatus) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | +[**replaceClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | +[**replaceNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#replaceNamespacedPodCertificateRequest) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | +[**replaceNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#replaceNamespacedPodCertificateRequestStatus) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | + +### createClusterTrustBundle + + + +> V1beta1ClusterTrustBundle createClusterTrustBundle(body) + +create a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiCreateClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiCreateClusterTrustBundleRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ClusterTrustBundle**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequest createNamespacedPodCertificateRequest(body) + +create a PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteClusterTrustBundle + + + +> V1Status deleteClusterTrustBundle() + +delete a ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiDeleteClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterTrustBundle + + + +> V1Status deleteCollectionClusterTrustBundle() + +delete collection of ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedPodCertificateRequest + + + +> V1Status deleteCollectionNamespacedPodCertificateRequest() + +delete collection of PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedPodCertificateRequest + + + +> V1Status deleteNamespacedPodCertificateRequest() + +delete a PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterTrustBundle + + + +> V1beta1ClusterTrustBundleList listClusterTrustBundle() + +list or watch objects of kind ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiListClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListClusterTrustBundleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequestList listNamespacedPodCertificateRequest() + +list or watch objects of kind PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequestList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listPodCertificateRequestForAllNamespaces + + + +> V1beta1PodCertificateRequestList listPodCertificateRequestForAllNamespaces() + +list or watch objects of kind PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listPodCertificateRequestForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequestList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterTrustBundle + + + +> V1beta1ClusterTrustBundle patchClusterTrustBundle(body) + +partially update the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiPatchClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequest(body) + +partially update the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedPodCertificateRequestStatus + + + +> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequestStatus(body) + +partially update status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readClusterTrustBundle + + + +> V1beta1ClusterTrustBundle readClusterTrustBundle() + +read the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReadClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequest readNamespacedPodCertificateRequest() + +read the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedPodCertificateRequestStatus + + + +> V1beta1PodCertificateRequest readNamespacedPodCertificateRequestStatus() + +read status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterTrustBundle + + + +> V1beta1ClusterTrustBundle replaceClusterTrustBundle(body) + +replace the specified ClusterTrustBundle + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReplaceClusterTrustBundleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceClusterTrustBundleRequest = { + // name of the ClusterTrustBundle + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + signerName: "signerName_example", + trustBundle: "trustBundle_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterTrustBundle(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1ClusterTrustBundle**| | + **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1ClusterTrustBundle + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodCertificateRequest + + + +> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequest(body) + +replace the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodCertificateRequest(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedPodCertificateRequestStatus + + + +> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequestStatus(body) + +replace status of the specified PodCertificateRequest + +### Example + + +```typescript +import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; +import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new CertificatesV1beta1Api(configuration); + +const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest = { + // name of the PodCertificateRequest + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + maxExpirationSeconds: 1, + nodeName: "nodeName_example", + nodeUID: "nodeUID_example", + pkixPublicKey: 'YQ==', + podName: "podName_example", + podUID: "podUID_example", + proofOfPossession: 'YQ==', + serviceAccountName: "serviceAccountName_example", + serviceAccountUID: "serviceAccountUID_example", + signerName: "signerName_example", + unverifiedUserAnnotations: { + "key": "key_example", + }, + }, + status: { + beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), + certificateChain: "certificateChain_example", + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + observedGeneration: 1, + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + notAfter: new Date('1970-01-01T00:00:00.00Z'), + notBefore: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedPodCertificateRequestStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1beta1PodCertificateRequest**| | + **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1beta1PodCertificateRequest + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationApi.md b/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationApi.md new file mode 100644 index 00000000000..02f45f4fa0c --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationApi.md @@ -0,0 +1,62 @@ +--- +id: RbacAuthorizationApi +title: RbacAuthorizationApi +sidebar_label: RbacAuthorizationApi +sidebar_position: 9 +--- +# RbacAuthorizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/security/RbacAuthorizationApi#getAPIGroup) | **GET** /apis/rbac.authorization.k8s.io/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationV1Api.md new file mode 100644 index 00000000000..84755290f3d --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationV1Api.md @@ -0,0 +1,3034 @@ +--- +id: RbacAuthorizationV1Api +title: RbacAuthorizationV1Api +sidebar_label: RbacAuthorizationV1Api +sidebar_position: 10 +--- +# RbacAuthorizationV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#createClusterRole) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**createClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#createClusterRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**createNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#createNamespacedRole) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**createNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#createNamespacedRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**deleteClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**deleteClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**deleteCollectionClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**deleteCollectionClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**deleteCollectionNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**deleteCollectionNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**deleteNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**deleteNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**getAPIResources**](/docs/api-reference/security/RbacAuthorizationV1Api#getAPIResources) | **GET** /apis/rbac.authorization.k8s.io/v1/ | +[**listClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#listClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles | +[**listClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#listClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | +[**listNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#listNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | +[**listNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#listNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | +[**listRoleBindingForAllNamespaces**](/docs/api-reference/security/RbacAuthorizationV1Api#listRoleBindingForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/rolebindings | +[**listRoleForAllNamespaces**](/docs/api-reference/security/RbacAuthorizationV1Api#listRoleForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/roles | +[**patchClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#patchClusterRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**patchClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#patchClusterRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**patchNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#patchNamespacedRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**patchNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#patchNamespacedRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**readClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#readClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**readClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#readClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**readNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#readNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**readNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#readNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | +[**replaceClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceClusterRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | +[**replaceClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceClusterRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | +[**replaceNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceNamespacedRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | +[**replaceNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceNamespacedRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | + +### createClusterRole + + + +> V1ClusterRole createClusterRole(body) + +create a ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiCreateClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateClusterRoleRequest = { + + body: { + aggregationRule: { + clusterRoleSelectors: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + ], + }, + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRole**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ClusterRole + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createClusterRoleBinding + + + +> V1ClusterRoleBinding createClusterRoleBinding(body) + +create a ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiCreateClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateClusterRoleBindingRequest = { + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRoleBinding**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedRole + + + +> V1Role createNamespacedRole(body) + +create a Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiCreateNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Role**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Role + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedRoleBinding + + + +> V1RoleBinding createNamespacedRoleBinding(body) + +create a RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RoleBinding**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1RoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteClusterRole + + + +> V1Status deleteClusterRole() + +delete a ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteClusterRoleBinding + + + +> V1Status deleteClusterRoleBinding() + +delete a ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterRole + + + +> V1Status deleteCollectionClusterRole() + +delete collection of ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionClusterRoleBinding + + + +> V1Status deleteCollectionClusterRoleBinding() + +delete collection of ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedRole + + + +> V1Status deleteCollectionNamespacedRole() + +delete collection of Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedRoleBinding + + + +> V1Status deleteCollectionNamespacedRoleBinding() + +delete collection of RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedRole + + + +> V1Status deleteNamespacedRole() + +delete a Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedRoleBinding + + + +> V1Status deleteNamespacedRoleBinding() + +delete a RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterRole + + + +> V1ClusterRoleList listClusterRole() + +list or watch objects of kind ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListClusterRoleRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listClusterRoleBinding + + + +> V1ClusterRoleBindingList listClusterRoleBinding() + +list or watch objects of kind ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListClusterRoleBindingRequest = { + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedRole + + + +> V1RoleList listNamespacedRole() + +list or watch objects of kind Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListNamespacedRoleRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RoleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedRoleBinding + + + +> V1RoleBindingList listNamespacedRoleBinding() + +list or watch objects of kind RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListNamespacedRoleBindingRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RoleBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listRoleBindingForAllNamespaces + + + +> V1RoleBindingList listRoleBindingForAllNamespaces() + +list or watch objects of kind RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRoleBindingForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RoleBindingList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listRoleForAllNamespaces + + + +> V1RoleList listRoleForAllNamespaces() + +list or watch objects of kind Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiListRoleForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiListRoleForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listRoleForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1RoleList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchClusterRole + + + +> V1ClusterRole patchClusterRole(body) + +partially update the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiPatchClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ClusterRole + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchClusterRoleBinding + + + +> V1ClusterRoleBinding patchClusterRoleBinding(body) + +partially update the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiPatchClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedRole + + + +> V1Role patchNamespacedRole(body) + +partially update the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiPatchNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Role + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedRoleBinding + + + +> V1RoleBinding patchNamespacedRoleBinding(body) + +partially update the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1RoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readClusterRole + + + +> V1ClusterRole readClusterRole() + +read the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReadClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ClusterRole + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readClusterRoleBinding + + + +> V1ClusterRoleBinding readClusterRoleBinding() + +read the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReadClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedRole + + + +> V1Role readNamespacedRole() + +read the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReadNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Role + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedRoleBinding + + + +> V1RoleBinding readNamespacedRoleBinding() + +read the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1RoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceClusterRole + + + +> V1ClusterRole replaceClusterRole(body) + +replace the specified ClusterRole + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReplaceClusterRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceClusterRoleRequest = { + // name of the ClusterRole + name: "name_example", + + body: { + aggregationRule: { + clusterRoleSelectors: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + ], + }, + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRole**| | + **name** | [**string**] | name of the ClusterRole | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ClusterRole + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceClusterRoleBinding + + + +> V1ClusterRoleBinding replaceClusterRoleBinding(body) + +replace the specified ClusterRoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest = { + // name of the ClusterRoleBinding + name: "name_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceClusterRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ClusterRoleBinding**| | + **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ClusterRoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedRole + + + +> V1Role replaceNamespacedRole(body) + +replace the specified Role + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReplaceNamespacedRoleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceNamespacedRoleRequest = { + // name of the Role + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + rules: [ + { + apiGroups: [ + "apiGroups_example", + ], + nonResourceURLs: [ + "nonResourceURLs_example", + ], + resourceNames: [ + "resourceNames_example", + ], + resources: [ + "resources_example", + ], + verbs: [ + "verbs_example", + ], + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedRole(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Role**| | + **name** | [**string**] | name of the Role | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Role + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedRoleBinding + + + +> V1RoleBinding replaceNamespacedRoleBinding(body) + +replace the specified RoleBinding + +### Example + + +```typescript +import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; +import type { RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new RbacAuthorizationV1Api(configuration); + +const request: RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest = { + // name of the RoleBinding + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + roleRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + subjects: [ + { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + ], + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedRoleBinding(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1RoleBinding**| | + **name** | [**string**] | name of the RoleBinding | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1RoleBinding + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/security/_category_.json new file mode 100644 index 00000000000..45fba4709cc --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/security/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Security", + "position": 4 +} diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsApi.md b/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsApi.md new file mode 100644 index 00000000000..ca768916c31 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsApi.md @@ -0,0 +1,62 @@ +--- +id: AppsApi +title: AppsApi +sidebar_label: AppsApi +sidebar_position: 1 +--- +# AppsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/workloads/AppsApi#getAPIGroup) | **GET** /apis/apps/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, AppsApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsV1Api.md new file mode 100644 index 00000000000..61a75520691 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsV1Api.md @@ -0,0 +1,28122 @@ +--- +id: AppsV1Api +title: AppsV1Api +sidebar_label: AppsV1Api +sidebar_position: 2 +--- +# AppsV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#createNamespacedControllerRevision) | **POST** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**createNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedDaemonSet) | **POST** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**createNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#createNamespacedDeployment) | **POST** /apis/apps/v1/namespaces/{namespace}/deployments | +[**createNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedReplicaSet) | **POST** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**createNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedStatefulSet) | **POST** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**deleteCollectionNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**deleteCollectionNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**deleteCollectionNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments | +[**deleteCollectionNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**deleteCollectionNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**deleteNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**deleteNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**deleteNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**deleteNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**deleteNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**getAPIResources**](/docs/api-reference/workloads/AppsV1Api#getAPIResources) | **GET** /apis/apps/v1/ | +[**listControllerRevisionForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listControllerRevisionForAllNamespaces) | **GET** /apis/apps/v1/controllerrevisions | +[**listDaemonSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listDaemonSetForAllNamespaces) | **GET** /apis/apps/v1/daemonsets | +[**listDeploymentForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listDeploymentForAllNamespaces) | **GET** /apis/apps/v1/deployments | +[**listNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#listNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | +[**listNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets | +[**listNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#listNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments | +[**listNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets | +[**listNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets | +[**listReplicaSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listReplicaSetForAllNamespaces) | **GET** /apis/apps/v1/replicasets | +[**listStatefulSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listStatefulSetForAllNamespaces) | **GET** /apis/apps/v1/statefulsets | +[**patchNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedControllerRevision) | **PATCH** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**patchNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDaemonSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**patchNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDaemonSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**patchNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeployment) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**patchNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeploymentScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**patchNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeploymentStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**patchNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**patchNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**patchNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**patchNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**patchNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**patchNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | +[**readNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#readNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**readNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**readNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDaemonSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**readNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**readNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeploymentScale) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**readNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeploymentStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**readNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**readNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**readNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**readNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**readNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**readNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | +[**replaceNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedControllerRevision) | **PUT** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | +[**replaceNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDaemonSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | +[**replaceNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDaemonSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | +[**replaceNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeployment) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | +[**replaceNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeploymentScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | +[**replaceNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeploymentStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | +[**replaceNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | +[**replaceNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | +[**replaceNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | +[**replaceNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | +[**replaceNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | +[**replaceNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | + +### createNamespacedControllerRevision + + + +> V1ControllerRevision createNamespacedControllerRevision(body) + +create a ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: {}, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + revision: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ControllerRevision**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ControllerRevision + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedDaemonSet + + + +> V1DaemonSet createNamespacedDaemonSet(body) + +create a DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedDeployment + + + +> V1Deployment createNamespacedDeployment(body) + +create a Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedReplicaSet + + + +> V1ReplicaSet createNamespacedReplicaSet(body) + +create a ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedStatefulSet + + + +> V1StatefulSet createNamespacedStatefulSet(body) + +create a StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiCreateNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiCreateNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedControllerRevision + + + +> V1Status deleteCollectionNamespacedControllerRevision() + +delete collection of ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedDaemonSet + + + +> V1Status deleteCollectionNamespacedDaemonSet() + +delete collection of DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedDeployment + + + +> V1Status deleteCollectionNamespacedDeployment() + +delete collection of Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedReplicaSet + + + +> V1Status deleteCollectionNamespacedReplicaSet() + +delete collection of ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedStatefulSet + + + +> V1Status deleteCollectionNamespacedStatefulSet() + +delete collection of StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedControllerRevision + + + +> V1Status deleteNamespacedControllerRevision() + +delete a ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedDaemonSet + + + +> V1Status deleteNamespacedDaemonSet() + +delete a DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedDeployment + + + +> V1Status deleteNamespacedDeployment() + +delete a Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedReplicaSet + + + +> V1Status deleteNamespacedReplicaSet() + +delete a ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedStatefulSet + + + +> V1Status deleteNamespacedStatefulSet() + +delete a StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiDeleteNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiDeleteNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listControllerRevisionForAllNamespaces + + + +> V1ControllerRevisionList listControllerRevisionForAllNamespaces() + +list or watch objects of kind ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListControllerRevisionForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListControllerRevisionForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listControllerRevisionForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ControllerRevisionList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDaemonSetForAllNamespaces + + + +> V1DaemonSetList listDaemonSetForAllNamespaces() + +list or watch objects of kind DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListDaemonSetForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListDaemonSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDaemonSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DaemonSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listDeploymentForAllNamespaces + + + +> V1DeploymentList listDeploymentForAllNamespaces() + +list or watch objects of kind Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListDeploymentForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListDeploymentForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listDeploymentForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DeploymentList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedControllerRevision + + + +> V1ControllerRevisionList listNamespacedControllerRevision() + +list or watch objects of kind ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedControllerRevisionRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ControllerRevisionList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedDaemonSet + + + +> V1DaemonSetList listNamespacedDaemonSet() + +list or watch objects of kind DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedDaemonSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DaemonSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedDeployment + + + +> V1DeploymentList listNamespacedDeployment() + +list or watch objects of kind Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedDeploymentRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1DeploymentList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedReplicaSet + + + +> V1ReplicaSetList listNamespacedReplicaSet() + +list or watch objects of kind ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedReplicaSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ReplicaSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedStatefulSet + + + +> V1StatefulSetList listNamespacedStatefulSet() + +list or watch objects of kind StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListNamespacedStatefulSetRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1StatefulSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listReplicaSetForAllNamespaces + + + +> V1ReplicaSetList listReplicaSetForAllNamespaces() + +list or watch objects of kind ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListReplicaSetForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListReplicaSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listReplicaSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1ReplicaSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listStatefulSetForAllNamespaces + + + +> V1StatefulSetList listStatefulSetForAllNamespaces() + +list or watch objects of kind StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiListStatefulSetForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiListStatefulSetForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listStatefulSetForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1StatefulSetList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedControllerRevision + + + +> V1ControllerRevision patchNamespacedControllerRevision(body) + +partially update the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ControllerRevision + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDaemonSet + + + +> V1DaemonSet patchNamespacedDaemonSet(body) + +partially update the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDaemonSetStatus + + + +> V1DaemonSet patchNamespacedDaemonSetStatus(body) + +partially update status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDeployment + + + +> V1Deployment patchNamespacedDeployment(body) + +partially update the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDeploymentScale + + + +> V1Scale patchNamespacedDeploymentScale(body) + +partially update scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedDeploymentStatus + + + +> V1Deployment patchNamespacedDeploymentStatus(body) + +partially update status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicaSet + + + +> V1ReplicaSet patchNamespacedReplicaSet(body) + +partially update the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicaSetScale + + + +> V1Scale patchNamespacedReplicaSetScale(body) + +partially update scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedReplicaSetStatus + + + +> V1ReplicaSet patchNamespacedReplicaSetStatus(body) + +partially update status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedStatefulSet + + + +> V1StatefulSet patchNamespacedStatefulSet(body) + +partially update the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedStatefulSetScale + + + +> V1Scale patchNamespacedStatefulSetScale(body) + +partially update scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedStatefulSetStatus + + + +> V1StatefulSet patchNamespacedStatefulSetStatus(body) + +partially update status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiPatchNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiPatchNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedControllerRevision + + + +> V1ControllerRevision readNamespacedControllerRevision() + +read the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ControllerRevision + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDaemonSet + + + +> V1DaemonSet readNamespacedDaemonSet() + +read the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDaemonSetStatus + + + +> V1DaemonSet readNamespacedDaemonSetStatus() + +read status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDeployment + + + +> V1Deployment readNamespacedDeployment() + +read the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDeploymentScale + + + +> V1Scale readNamespacedDeploymentScale() + +read scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedDeploymentStatus + + + +> V1Deployment readNamespacedDeploymentStatus() + +read status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicaSet + + + +> V1ReplicaSet readNamespacedReplicaSet() + +read the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicaSetScale + + + +> V1Scale readNamespacedReplicaSetScale() + +read scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedReplicaSetStatus + + + +> V1ReplicaSet readNamespacedReplicaSetStatus() + +read status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedStatefulSet + + + +> V1StatefulSet readNamespacedStatefulSet() + +read the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedStatefulSetScale + + + +> V1Scale readNamespacedStatefulSetScale() + +read scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedStatefulSetStatus + + + +> V1StatefulSet readNamespacedStatefulSetStatus() + +read status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReadNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReadNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedControllerRevision + + + +> V1ControllerRevision replaceNamespacedControllerRevision(body) + +replace the specified ControllerRevision + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedControllerRevisionRequest = { + // name of the ControllerRevision + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + data: {}, + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + revision: 1, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedControllerRevision(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ControllerRevision**| | + **name** | [**string**] | name of the ControllerRevision | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ControllerRevision + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDaemonSet + + + +> V1DaemonSet replaceNamespacedDaemonSet(body) + +replace the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDaemonSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDaemonSetRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDaemonSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDaemonSetStatus + + + +> V1DaemonSet replaceNamespacedDaemonSetStatus(body) + +replace status of the specified DaemonSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDaemonSetStatusRequest = { + // name of the DaemonSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + }, + status: { + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentNumberScheduled: 1, + desiredNumberScheduled: 1, + numberAvailable: 1, + numberMisscheduled: 1, + numberReady: 1, + numberUnavailable: 1, + observedGeneration: 1, + updatedNumberScheduled: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDaemonSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DaemonSet**| | + **name** | [**string**] | name of the DaemonSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1DaemonSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDeployment + + + +> V1Deployment replaceNamespacedDeployment(body) + +replace the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDeploymentRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeployment(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDeploymentScale + + + +> V1Scale replaceNamespacedDeploymentScale(body) + +replace scale of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeploymentScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedDeploymentStatus + + + +> V1Deployment replaceNamespacedDeploymentStatus(body) + +replace status of the specified Deployment + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedDeploymentStatusRequest = { + // name of the Deployment + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + paused: true, + progressDeadlineSeconds: 1, + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + strategy: { + rollingUpdate: { + maxSurge: "maxSurge_example", + maxUnavailable: "maxUnavailable_example", + }, + type: "type_example", + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + unavailableReplicas: 1, + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedDeploymentStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Deployment**| | + **name** | [**string**] | name of the Deployment | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Deployment + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicaSet + + + +> V1ReplicaSet replaceNamespacedReplicaSet(body) + +replace the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedReplicaSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicaSetScale + + + +> V1Scale replaceNamespacedReplicaSetScale(body) + +replace scale of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedReplicaSetStatus + + + +> V1ReplicaSet replaceNamespacedReplicaSetStatus(body) + +replace status of the specified ReplicaSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedReplicaSetStatusRequest = { + // name of the ReplicaSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + replicas: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + }, + status: { + availableReplicas: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + fullyLabeledReplicas: 1, + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + terminatingReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedReplicaSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1ReplicaSet**| | + **name** | [**string**] | name of the ReplicaSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1ReplicaSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedStatefulSet + + + +> V1StatefulSet replaceNamespacedStatefulSet(body) + +replace the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedStatefulSetRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSet(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedStatefulSetScale + + + +> V1Scale replaceNamespacedStatefulSetScale(body) + +replace scale of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetScaleRequest = { + // name of the Scale + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + replicas: 1, + }, + status: { + replicas: 1, + selector: "selector_example", + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSetScale(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Scale**| | + **name** | [**string**] | name of the Scale | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Scale + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedStatefulSetStatus + + + +> V1StatefulSet replaceNamespacedStatefulSetStatus(body) + +replace status of the specified StatefulSet + +### Example + + +```typescript +import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; +import type { AppsV1ApiReplaceNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); + +const request: AppsV1ApiReplaceNamespacedStatefulSetStatusRequest = { + // name of the StatefulSet + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + minReadySeconds: 1, + ordinals: { + start: 1, + }, + persistentVolumeClaimRetentionPolicy: { + whenDeleted: "whenDeleted_example", + whenScaled: "whenScaled_example", + }, + podManagementPolicy: "podManagementPolicy_example", + replicas: 1, + revisionHistoryLimit: 1, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + serviceName: "serviceName_example", + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + updateStrategy: { + rollingUpdate: { + maxUnavailable: "maxUnavailable_example", + partition: 1, + }, + type: "type_example", + }, + volumeClaimTemplates: [ + { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + status: { + accessModes: [ + "accessModes_example", + ], + allocatedResourceStatuses: { + "key": "key_example", + }, + allocatedResources: { + "key": "key_example", + }, + capacity: { + "key": "key_example", + }, + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", + modifyVolumeStatus: { + status: "status_example", + targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", + }, + phase: "phase_example", + }, + }, + ], + }, + status: { + availableReplicas: 1, + collisionCount: 1, + conditions: [ + { + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + currentReplicas: 1, + currentRevision: "currentRevision_example", + observedGeneration: 1, + readyReplicas: 1, + replicas: 1, + updateRevision: "updateRevision_example", + updatedReplicas: 1, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedStatefulSetStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1StatefulSet**| | + **name** | [**string**] | name of the StatefulSet | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1StatefulSet + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchApi.md b/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchApi.md new file mode 100644 index 00000000000..6eecc6c2da6 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchApi.md @@ -0,0 +1,62 @@ +--- +id: BatchApi +title: BatchApi +sidebar_label: BatchApi +sidebar_position: 3 +--- +# BatchApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAPIGroup**](/docs/api-reference/workloads/BatchApi#getAPIGroup) | **GET** /apis/batch/ | + +### getAPIGroup + + + +> V1APIGroup getAPIGroup() + +get information of a group + +### Example + + +```typescript +import { createConfiguration, BatchApi } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchApi(configuration); + +const request = {}; + +const data = await apiInstance.getAPIGroup(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIGroup + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchV1Api.md new file mode 100644 index 00000000000..3a672c79b93 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchV1Api.md @@ -0,0 +1,13489 @@ +--- +id: BatchV1Api +title: BatchV1Api +sidebar_label: BatchV1Api +sidebar_position: 4 +--- +# BatchV1Api + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#createNamespacedCronJob) | **POST** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**createNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#createNamespacedJob) | **POST** /apis/batch/v1/namespaces/{namespace}/jobs | +[**deleteCollectionNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#deleteCollectionNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**deleteCollectionNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#deleteCollectionNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs | +[**deleteNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#deleteNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**deleteNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#deleteNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**getAPIResources**](/docs/api-reference/workloads/BatchV1Api#getAPIResources) | **GET** /apis/batch/v1/ | +[**listCronJobForAllNamespaces**](/docs/api-reference/workloads/BatchV1Api#listCronJobForAllNamespaces) | **GET** /apis/batch/v1/cronjobs | +[**listJobForAllNamespaces**](/docs/api-reference/workloads/BatchV1Api#listJobForAllNamespaces) | **GET** /apis/batch/v1/jobs | +[**listNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#listNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs | +[**listNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#listNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs | +[**patchNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedCronJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**patchNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedCronJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**patchNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**patchNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | +[**readNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#readNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**readNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#readNamespacedCronJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**readNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#readNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**readNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#readNamespacedJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | +[**replaceNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedCronJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | +[**replaceNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedCronJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | +[**replaceNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | +[**replaceNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | + +### createNamespacedCronJob + + + +> V1CronJob createNamespacedCronJob(body) + +create a CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiCreateNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiCreateNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### createNamespacedJob + + + +> V1Job createNamespacedJob(body) + +create a Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiCreateNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiCreateNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.createNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedCronJob + + + +> V1Status deleteCollectionNamespacedCronJob() + +delete collection of CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiDeleteCollectionNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteCollectionNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteCollectionNamespacedJob + + + +> V1Status deleteCollectionNamespacedJob() + +delete collection of Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiDeleteCollectionNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteCollectionNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteCollectionNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### deleteNamespacedCronJob + + + +> V1Status deleteNamespacedCronJob() + +delete a CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiDeleteNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### deleteNamespacedJob + + + +> V1Status deleteNamespacedJob() + +delete a Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiDeleteNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiDeleteNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) + gracePeriodSeconds: 1, + // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) + ignoreStoreReadErrorWithClusterBreakingPotential: true, + // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) + orphanDependents: true, + // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) + propagationPolicy: "propagationPolicy_example", + + body: { + apiVersion: "apiVersion_example", + dryRun: [ + "dryRun_example", + ], + gracePeriodSeconds: 1, + ignoreStoreReadErrorWithClusterBreakingPotential: true, + kind: "kind_example", + orphanDependents: true, + preconditions: { + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + propagationPolicy: "propagationPolicy_example", + }, +}; + +const data = await apiInstance.deleteNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1DeleteOptions**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined + **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined + **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined + **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined + +### Return type + +V1Status + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**202** | Accepted | - | +**401** | Unauthorized | - | + +### getAPIResources + + + +> V1APIResourceList getAPIResources() + +get available resources + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request = {}; + +const data = await apiInstance.getAPIResources(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +This endpoint does not need any parameter. + +### Return type + +V1APIResourceList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listCronJobForAllNamespaces + + + +> V1CronJobList listCronJobForAllNamespaces() + +list or watch objects of kind CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiListCronJobForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListCronJobForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listCronJobForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CronJobList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listJobForAllNamespaces + + + +> V1JobList listJobForAllNamespaces() + +list or watch objects of kind Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiListJobForAllNamespacesRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListJobForAllNamespacesRequest = { + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listJobForAllNamespaces(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1JobList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedCronJob + + + +> V1CronJobList listNamespacedCronJob() + +list or watch objects of kind CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiListNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListNamespacedCronJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1CronJobList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### listNamespacedJob + + + +> V1JobList listNamespacedJob() + +list or watch objects of kind Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiListNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiListNamespacedJobRequest = { + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) + allowWatchBookmarks: true, + // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) + _continue: "continue_example", + // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) + fieldSelector: "fieldSelector_example", + // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) + labelSelector: "labelSelector_example", + // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) + limit: 1, + // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersion: "resourceVersion_example", + // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) + resourceVersionMatch: "resourceVersionMatch_example", + // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) + sendInitialEvents: true, + // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) + timeoutSeconds: 1, + // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) + watch: true, +}; + +const data = await apiInstance.listNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined + **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined + **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined + **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined + **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined + **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined + **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined + **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined + **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined + +### Return type + +V1JobList + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### patchNamespacedCronJob + + + +> V1CronJob patchNamespacedCronJob(body) + +partially update the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiPatchNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedCronJobStatus + + + +> V1CronJob patchNamespacedCronJobStatus(body) + +partially update status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiPatchNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedJob + + + +> V1Job patchNamespacedJob(body) + +partially update the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiPatchNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### patchNamespacedJobStatus + + + +> V1Job patchNamespacedJobStatus(body) + +partially update status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiPatchNamespacedJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiPatchNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: {}, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", + // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) + force: true, +}; + +const data = await apiInstance.patchNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **any**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### readNamespacedCronJob + + + +> V1CronJob readNamespacedCronJob() + +read the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReadNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedCronJobStatus + + + +> V1CronJob readNamespacedCronJobStatus() + +read status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReadNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedJob + + + +> V1Job readNamespacedJob() + +read the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReadNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### readNamespacedJobStatus + + + +> V1Job readNamespacedJobStatus() + +read status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReadNamespacedJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReadNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", +}; + +const data = await apiInstance.readNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | + +### replaceNamespacedCronJob + + + +> V1CronJob replaceNamespacedCronJob(body) + +replace the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReplaceNamespacedCronJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedCronJobRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCronJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedCronJobStatus + + + +> V1CronJob replaceNamespacedCronJobStatus(body) + +replace status of the specified CronJob + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReplaceNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedCronJobStatusRequest = { + // name of the CronJob + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + concurrencyPolicy: "concurrencyPolicy_example", + failedJobsHistoryLimit: 1, + jobTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + }, + schedule: "schedule_example", + startingDeadlineSeconds: 1, + successfulJobsHistoryLimit: 1, + suspend: true, + timeZone: "timeZone_example", + }, + status: { + active: [ + { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + resourceVersion: "resourceVersion_example", + uid: "uid_example", + }, + ], + lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), + lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedCronJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1CronJob**| | + **name** | [**string**] | name of the CronJob | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1CronJob + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedJob + + + +> V1Job replaceNamespacedJob(body) + +replace the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReplaceNamespacedJobRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedJobRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedJob(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + +### replaceNamespacedJobStatus + + + +> V1Job replaceNamespacedJobStatus(body) + +replace status of the specified Job + +### Example + + +```typescript +import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; +import type { BatchV1ApiReplaceNamespacedJobStatusRequest } from '@kubernetes/client-node'; + +const configuration = createConfiguration(); +const apiInstance = new BatchV1Api(configuration); + +const request: BatchV1ApiReplaceNamespacedJobStatusRequest = { + // name of the Job + name: "name_example", + // object name and auth scope, such as for teams and projects + namespace: "namespace_example", + + body: { + apiVersion: "apiVersion_example", + kind: "kind_example", + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + backoffLimit: 1, + backoffLimitPerIndex: 1, + completionMode: "completionMode_example", + completions: 1, + managedBy: "managedBy_example", + manualSelector: true, + maxFailedIndexes: 1, + parallelism: 1, + podFailurePolicy: { + rules: [ + { + action: "action_example", + onExitCodes: { + containerName: "containerName_example", + operator: "operator_example", + values: [ + 1, + ], + }, + onPodConditions: [ + { + status: "status_example", + type: "type_example", + }, + ], + }, + ], + }, + podReplacementPolicy: "podReplacementPolicy_example", + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + successPolicy: { + rules: [ + { + succeededCount: 1, + succeededIndexes: "succeededIndexes_example", + }, + ], + }, + suspend: true, + template: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + activeDeadlineSeconds: 1, + affinity: { + nodeAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + preference: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: { + nodeSelectorTerms: [ + { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchFields: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + }, + ], + }, + }, + podAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + podAntiAffinity: { + preferredDuringSchedulingIgnoredDuringExecution: [ + { + podAffinityTerm: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + weight: 1, + }, + ], + requiredDuringSchedulingIgnoredDuringExecution: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + mismatchLabelKeys: [ + "mismatchLabelKeys_example", + ], + namespaceSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + namespaces: [ + "namespaces_example", + ], + topologyKey: "topologyKey_example", + }, + ], + }, + }, + automountServiceAccountToken: true, + containers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + dnsConfig: { + nameservers: [ + "nameservers_example", + ], + options: [ + { + name: "name_example", + value: "value_example", + }, + ], + searches: [ + "searches_example", + ], + }, + dnsPolicy: "dnsPolicy_example", + enableServiceLinks: true, + ephemeralContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + targetContainerName: "targetContainerName_example", + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + hostAliases: [ + { + hostnames: [ + "hostnames_example", + ], + ip: "ip_example", + }, + ], + hostIPC: true, + hostNetwork: true, + hostPID: true, + hostUsers: true, + hostname: "hostname_example", + hostnameOverride: "hostnameOverride_example", + imagePullSecrets: [ + { + name: "name_example", + }, + ], + initContainers: [ + { + args: [ + "args_example", + ], + command: [ + "command_example", + ], + env: [ + { + name: "name_example", + value: "value_example", + valueFrom: { + configMapKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + fileKeyRef: { + key: "key_example", + optional: true, + path: "path_example", + volumeName: "volumeName_example", + }, + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + secretKeyRef: { + key: "key_example", + name: "name_example", + optional: true, + }, + }, + }, + ], + envFrom: [ + { + configMapRef: { + name: "name_example", + optional: true, + }, + prefix: "prefix_example", + secretRef: { + name: "name_example", + optional: true, + }, + }, + ], + image: "image_example", + imagePullPolicy: "imagePullPolicy_example", + lifecycle: { + postStart: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + preStop: { + exec: { + command: [ + "command_example", + ], + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + sleep: { + seconds: 1, + }, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + }, + stopSignal: "stopSignal_example", + }, + livenessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + name: "name_example", + ports: [ + { + containerPort: 1, + hostIP: "hostIP_example", + hostPort: 1, + name: "name_example", + protocol: "protocol_example", + }, + ], + readinessProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + resizePolicy: [ + { + resourceName: "resourceName_example", + restartPolicy: "restartPolicy_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + restartPolicyRules: [ + { + action: "action_example", + exitCodes: { + operator: "operator_example", + values: [ + 1, + ], + }, + }, + ], + securityContext: { + allowPrivilegeEscalation: true, + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + capabilities: { + add: [ + "add_example", + ], + drop: [ + "drop_example", + ], + }, + privileged: true, + procMount: "procMount_example", + readOnlyRootFilesystem: true, + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + startupProbe: { + exec: { + command: [ + "command_example", + ], + }, + failureThreshold: 1, + grpc: { + port: 1, + service: "service_example", + }, + httpGet: { + host: "host_example", + httpHeaders: [ + { + name: "name_example", + value: "value_example", + }, + ], + path: "path_example", + port: "port_example", + scheme: "scheme_example", + }, + initialDelaySeconds: 1, + periodSeconds: 1, + successThreshold: 1, + tcpSocket: { + host: "host_example", + port: "port_example", + }, + terminationGracePeriodSeconds: 1, + timeoutSeconds: 1, + }, + stdin: true, + stdinOnce: true, + terminationMessagePath: "terminationMessagePath_example", + terminationMessagePolicy: "terminationMessagePolicy_example", + tty: true, + volumeDevices: [ + { + devicePath: "devicePath_example", + name: "name_example", + }, + ], + volumeMounts: [ + { + mountPath: "mountPath_example", + mountPropagation: "mountPropagation_example", + name: "name_example", + readOnly: true, + recursiveReadOnly: "recursiveReadOnly_example", + subPath: "subPath_example", + subPathExpr: "subPathExpr_example", + }, + ], + workingDir: "workingDir_example", + }, + ], + nodeName: "nodeName_example", + nodeSelector: { + "key": "key_example", + }, + os: { + name: "name_example", + }, + overhead: { + "key": "key_example", + }, + preemptionPolicy: "preemptionPolicy_example", + priority: 1, + priorityClassName: "priorityClassName_example", + readinessGates: [ + { + conditionType: "conditionType_example", + }, + ], + resourceClaims: [ + { + name: "name_example", + resourceClaimName: "resourceClaimName_example", + resourceClaimTemplateName: "resourceClaimTemplateName_example", + }, + ], + resources: { + claims: [ + { + name: "name_example", + request: "request_example", + }, + ], + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + restartPolicy: "restartPolicy_example", + runtimeClassName: "runtimeClassName_example", + schedulerName: "schedulerName_example", + schedulingGates: [ + { + name: "name_example", + }, + ], + securityContext: { + appArmorProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + fsGroup: 1, + fsGroupChangePolicy: "fsGroupChangePolicy_example", + runAsGroup: 1, + runAsNonRoot: true, + runAsUser: 1, + seLinuxChangePolicy: "seLinuxChangePolicy_example", + seLinuxOptions: { + level: "level_example", + role: "role_example", + type: "type_example", + user: "user_example", + }, + seccompProfile: { + localhostProfile: "localhostProfile_example", + type: "type_example", + }, + supplementalGroups: [ + 1, + ], + supplementalGroupsPolicy: "supplementalGroupsPolicy_example", + sysctls: [ + { + name: "name_example", + value: "value_example", + }, + ], + windowsOptions: { + gmsaCredentialSpec: "gmsaCredentialSpec_example", + gmsaCredentialSpecName: "gmsaCredentialSpecName_example", + hostProcess: true, + runAsUserName: "runAsUserName_example", + }, + }, + serviceAccount: "serviceAccount_example", + serviceAccountName: "serviceAccountName_example", + setHostnameAsFQDN: true, + shareProcessNamespace: true, + subdomain: "subdomain_example", + terminationGracePeriodSeconds: 1, + tolerations: [ + { + effect: "effect_example", + key: "key_example", + operator: "operator_example", + tolerationSeconds: 1, + value: "value_example", + }, + ], + topologySpreadConstraints: [ + { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + matchLabelKeys: [ + "matchLabelKeys_example", + ], + maxSkew: 1, + minDomains: 1, + nodeAffinityPolicy: "nodeAffinityPolicy_example", + nodeTaintsPolicy: "nodeTaintsPolicy_example", + topologyKey: "topologyKey_example", + whenUnsatisfiable: "whenUnsatisfiable_example", + }, + ], + volumes: [ + { + awsElasticBlockStore: { + fsType: "fsType_example", + partition: 1, + readOnly: true, + volumeID: "volumeID_example", + }, + azureDisk: { + cachingMode: "cachingMode_example", + diskName: "diskName_example", + diskURI: "diskURI_example", + fsType: "fsType_example", + kind: "kind_example", + readOnly: true, + }, + azureFile: { + readOnly: true, + secretName: "secretName_example", + shareName: "shareName_example", + }, + cephfs: { + monitors: [ + "monitors_example", + ], + path: "path_example", + readOnly: true, + secretFile: "secretFile_example", + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + cinder: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeID: "volumeID_example", + }, + configMap: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + csi: { + driver: "driver_example", + fsType: "fsType_example", + nodePublishSecretRef: { + name: "name_example", + }, + readOnly: true, + volumeAttributes: { + "key": "key_example", + }, + }, + downwardAPI: { + defaultMode: 1, + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + emptyDir: { + medium: "medium_example", + sizeLimit: "sizeLimit_example", + }, + ephemeral: { + volumeClaimTemplate: { + metadata: { + annotations: { + "key": "key_example", + }, + creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), + deletionGracePeriodSeconds: 1, + deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), + finalizers: [ + "finalizers_example", + ], + generateName: "generateName_example", + generation: 1, + labels: { + "key": "key_example", + }, + managedFields: [ + { + apiVersion: "apiVersion_example", + fieldsType: "fieldsType_example", + fieldsV1: {}, + manager: "manager_example", + operation: "operation_example", + subresource: "subresource_example", + time: new Date('1970-01-01T00:00:00.00Z'), + }, + ], + name: "name_example", + namespace: "namespace_example", + ownerReferences: [ + { + apiVersion: "apiVersion_example", + blockOwnerDeletion: true, + controller: true, + kind: "kind_example", + name: "name_example", + uid: "uid_example", + }, + ], + resourceVersion: "resourceVersion_example", + selfLink: "selfLink_example", + uid: "uid_example", + }, + spec: { + accessModes: [ + "accessModes_example", + ], + dataSource: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + }, + dataSourceRef: { + apiGroup: "apiGroup_example", + kind: "kind_example", + name: "name_example", + namespace: "namespace_example", + }, + resources: { + limits: { + "key": "key_example", + }, + requests: { + "key": "key_example", + }, + }, + selector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + storageClassName: "storageClassName_example", + volumeAttributesClassName: "volumeAttributesClassName_example", + volumeMode: "volumeMode_example", + volumeName: "volumeName_example", + }, + }, + }, + fc: { + fsType: "fsType_example", + lun: 1, + readOnly: true, + targetWWNs: [ + "targetWWNs_example", + ], + wwids: [ + "wwids_example", + ], + }, + flexVolume: { + driver: "driver_example", + fsType: "fsType_example", + options: { + "key": "key_example", + }, + readOnly: true, + secretRef: { + name: "name_example", + }, + }, + flocker: { + datasetName: "datasetName_example", + datasetUUID: "datasetUUID_example", + }, + gcePersistentDisk: { + fsType: "fsType_example", + partition: 1, + pdName: "pdName_example", + readOnly: true, + }, + gitRepo: { + directory: "directory_example", + repository: "repository_example", + revision: "revision_example", + }, + glusterfs: { + endpoints: "endpoints_example", + path: "path_example", + readOnly: true, + }, + hostPath: { + path: "path_example", + type: "type_example", + }, + image: { + pullPolicy: "pullPolicy_example", + reference: "reference_example", + }, + iscsi: { + chapAuthDiscovery: true, + chapAuthSession: true, + fsType: "fsType_example", + initiatorName: "initiatorName_example", + iqn: "iqn_example", + iscsiInterface: "iscsiInterface_example", + lun: 1, + portals: [ + "portals_example", + ], + readOnly: true, + secretRef: { + name: "name_example", + }, + targetPortal: "targetPortal_example", + }, + name: "name_example", + nfs: { + path: "path_example", + readOnly: true, + server: "server_example", + }, + persistentVolumeClaim: { + claimName: "claimName_example", + readOnly: true, + }, + photonPersistentDisk: { + fsType: "fsType_example", + pdID: "pdID_example", + }, + portworxVolume: { + fsType: "fsType_example", + readOnly: true, + volumeID: "volumeID_example", + }, + projected: { + defaultMode: 1, + sources: [ + { + clusterTrustBundle: { + labelSelector: { + matchExpressions: [ + { + key: "key_example", + operator: "operator_example", + values: [ + "values_example", + ], + }, + ], + matchLabels: { + "key": "key_example", + }, + }, + name: "name_example", + optional: true, + path: "path_example", + signerName: "signerName_example", + }, + configMap: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + downwardAPI: { + items: [ + { + fieldRef: { + apiVersion: "apiVersion_example", + fieldPath: "fieldPath_example", + }, + mode: 1, + path: "path_example", + resourceFieldRef: { + containerName: "containerName_example", + divisor: "divisor_example", + resource: "resource_example", + }, + }, + ], + }, + podCertificate: { + certificateChainPath: "certificateChainPath_example", + credentialBundlePath: "credentialBundlePath_example", + keyPath: "keyPath_example", + keyType: "keyType_example", + maxExpirationSeconds: 1, + signerName: "signerName_example", + userAnnotations: { + "key": "key_example", + }, + }, + secret: { + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + name: "name_example", + optional: true, + }, + serviceAccountToken: { + audience: "audience_example", + expirationSeconds: 1, + path: "path_example", + }, + }, + ], + }, + quobyte: { + group: "group_example", + readOnly: true, + registry: "registry_example", + tenant: "tenant_example", + user: "user_example", + volume: "volume_example", + }, + rbd: { + fsType: "fsType_example", + image: "image_example", + keyring: "keyring_example", + monitors: [ + "monitors_example", + ], + pool: "pool_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + user: "user_example", + }, + scaleIO: { + fsType: "fsType_example", + gateway: "gateway_example", + protectionDomain: "protectionDomain_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + sslEnabled: true, + storageMode: "storageMode_example", + storagePool: "storagePool_example", + system: "system_example", + volumeName: "volumeName_example", + }, + secret: { + defaultMode: 1, + items: [ + { + key: "key_example", + mode: 1, + path: "path_example", + }, + ], + optional: true, + secretName: "secretName_example", + }, + storageos: { + fsType: "fsType_example", + readOnly: true, + secretRef: { + name: "name_example", + }, + volumeName: "volumeName_example", + volumeNamespace: "volumeNamespace_example", + }, + vsphereVolume: { + fsType: "fsType_example", + storagePolicyID: "storagePolicyID_example", + storagePolicyName: "storagePolicyName_example", + volumePath: "volumePath_example", + }, + }, + ], + workloadRef: { + name: "name_example", + podGroup: "podGroup_example", + podGroupReplicaKey: "podGroupReplicaKey_example", + }, + }, + }, + ttlSecondsAfterFinished: 1, + }, + status: { + active: 1, + completedIndexes: "completedIndexes_example", + completionTime: new Date('1970-01-01T00:00:00.00Z'), + conditions: [ + { + lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), + lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), + message: "message_example", + reason: "reason_example", + status: "status_example", + type: "type_example", + }, + ], + failed: 1, + failedIndexes: "failedIndexes_example", + ready: 1, + startTime: new Date('1970-01-01T00:00:00.00Z'), + succeeded: 1, + terminating: 1, + uncountedTerminatedPods: { + failed: [ + "failed_example", + ], + succeeded: [ + "succeeded_example", + ], + }, + }, + }, + // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) + pretty: "pretty_example", + // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) + dryRun: "dryRun_example", + // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) + fieldManager: "fieldManager_example", + // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) + fieldValidation: "fieldValidation_example", +}; + +const data = await apiInstance.replaceNamespacedJobStatus(request); +console.log('API called successfully. Returned data:', data); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **V1Job**| | + **name** | [**string**] | name of the Job | defaults to undefined + **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined + **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined + **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined + **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined + **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined + +### Return type + +V1Job + +### Authorization + + +[BearerToken](#authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**201** | Created | - | +**401** | Unauthorized | - | + diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/workloads/_category_.json new file mode 100644 index 00000000000..6f2c7368745 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/api-reference/workloads/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Workloads", + "position": 2 +} diff --git a/website/versioned_docs/version-2.0.0/intro.md b/website/versioned_docs/version-2.0.0/intro.md new file mode 100644 index 00000000000..a8103187d34 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/intro.md @@ -0,0 +1,81 @@ +--- +sidebar_position: 1 +--- + +# Introduction + +The Kubernetes JavaScript Client is the official Node.js client for interacting with Kubernetes clusters. It's written in TypeScript and provides a powerful, type-safe way to manage Kubernetes resources from your Node.js applications. + +## Installation + +Install the client using npm: + +```bash +npm install @kubernetes/client-node +``` + +## Quick Start + +The following example shows how to load your default KubeConfig and list all pods in the `default` namespace. + +```typescript +import * as k8s from '@kubernetes/client-node'; + +const kc = new k8s.KubeConfig(); +kc.loadFromDefault(); + +const k8sApi = kc.makeApiClient(k8s.CoreV1Api); + +async function listPods() { + try { + const res = await k8sApi.listNamespacedPod({ namespace: 'default' }); + console.log( + 'Pods:', + res.items.map((pod) => pod.metadata?.name), + ); + } catch (err) { + console.error('Error:', err); + } +} + +listPods(); +``` + +## KubeConfig Methods + +The `KubeConfig` class provides several ways to load your configuration: + +- `loadFromDefault()`: Loads from the default location (`~/.kube/config` or service account) +- `loadFromFile(path)`: Loads from a specific file +- `loadFromString(content)`: Loads from a YAML string +- `loadFromOptions(options)`: Loads from a programmatic object +- `loadFromCluster()`: Specifically for running inside a cluster (Service Account) + +## Compatibility + +Starting with release `0.13.0`, the minor version of this library tracks the minor Kubernetes API version it was generated from. + +| client version | older versions | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 | 1.33 | 1.34 | +| -------------- | -------------- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | +| 0.19.x | - | ✓ | x | x | x | x | x | x | +| 0.20.x | - | + | ✓ | x | x | x | x | x | +| 0.21.x | - | + | + | ✓ | x | x | x | x | +| 0.22.x | - | + | + | + | ✓ | x | x | x | +| 1.0.x | - | + | + | + | + | ✓ | x | x | +| 1.1.x | - | + | + | + | + | ✓ | x | x | +| 1.2.x | - | + | + | + | + | + | ✓ | x | +| 1.3.x | - | + | + | + | + | + | ✓ | x | +| 1.4.x | - | + | + | + | + | + | + | ✓ | + +**Key:** + +- `✓` Exactly the same features / API objects. +- `+` Client has more features than the cluster, common features work. +- `-` Cluster has features client can't use yet. +- `x` No guarantee of support (outside the n-2 version support window). + +## Links + +- [SDK Reference](/docs/sdk) +- [Kubernetes API Reference](https://kubernetes.io/docs/reference/) +- [GitHub Repository](https://github.com/kubernetes-client/javascript) diff --git a/website/versioned_docs/version-2.0.0/sdk/attach/classes/Attach.md b/website/versioned_docs/version-2.0.0/sdk/attach/classes/Attach.md new file mode 100644 index 00000000000..48cfdf54928 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/attach/classes/Attach.md @@ -0,0 +1,75 @@ +# Class: Attach + +Defined in: [src/attach.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/attach.ts#L9) + +## Constructors + +### Constructor + +> **new Attach**(`config`, `websocketInterface?`): `Attach` + +Defined in: [src/attach.ts:14](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/attach.ts#L14) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +##### websocketInterface? + +`WebSocketInterface` + +#### Returns + +`Attach` + +## Properties + +### handler + +> **handler**: `WebSocketInterface` + +Defined in: [src/attach.ts:10](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/attach.ts#L10) + +## Methods + +### attach() + +> **attach**(`namespace`, `podName`, `containerName`, `stdout`, `stderr`, `stdin`, `tty`): `Promise`\<`WebSocket`\> + +Defined in: [src/attach.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/attach.ts#L18) + +#### Parameters + +##### namespace + +`string` + +##### podName + +`string` + +##### containerName + +`string` + +##### stdout + +`any` + +##### stderr + +`any` + +##### stdin + +`any` + +##### tty + +`boolean` + +#### Returns + +`Promise`\<`WebSocket`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/attach/index.md b/website/versioned_docs/version-2.0.0/sdk/attach/index.md new file mode 100644 index 00000000000..5c8b2eedd03 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/attach/index.md @@ -0,0 +1,5 @@ +# attach + +## Classes + +- [Attach](classes/Attach.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/classes/ListWatch.md b/website/versioned_docs/version-2.0.0/sdk/cache/classes/ListWatch.md new file mode 100644 index 00000000000..b20747defda --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cache/classes/ListWatch.md @@ -0,0 +1,248 @@ +# Class: ListWatch\ + +Defined in: [src/cache.ts:26](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L26) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Implements + +- [`ObjectCache`](../interfaces/ObjectCache.md)\<`T`\> +- [`Informer`](../../informer/interfaces/Informer.md)\<`T`\> + +## Constructors + +### Constructor + +> **new ListWatch**\<`T`\>(`path`, `watch`, `listFn`, `autoStart?`, `labelSelector?`, `fieldSelector?`): `ListWatch`\<`T`\> + +Defined in: [src/cache.ts:39](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L39) + +#### Parameters + +##### path + +`string` + +##### watch + +[`Watch`](../../watch/classes/Watch.md) + +##### listFn + +[`ListPromise`](../../informer/type-aliases/ListPromise.md)\<`T`\> + +##### autoStart? + +`boolean` = `true` + +##### labelSelector? + +`string` + +##### fieldSelector? + +`string` + +#### Returns + +`ListWatch`\<`T`\> + +## Methods + +### get() + +> **get**(`name`, `namespace?`): `T` \| `undefined` + +Defined in: [src/cache.ts:113](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L113) + +#### Parameters + +##### name + +`string` + +##### namespace? + +`string` + +#### Returns + +`T` \| `undefined` + +#### Implementation of + +[`ObjectCache`](../interfaces/ObjectCache.md).[`get`](../interfaces/ObjectCache.md#get) + +*** + +### latestResourceVersion() + +> **latestResourceVersion**(): `string` + +Defined in: [src/cache.ts:136](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L136) + +#### Returns + +`string` + +*** + +### list() + +> **list**(`namespace?`): readonly `T`[] + +Defined in: [src/cache.ts:121](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L121) + +#### Parameters + +##### namespace? + +`string` + +#### Returns + +readonly `T`[] + +#### Implementation of + +[`ObjectCache`](../interfaces/ObjectCache.md).[`list`](../interfaces/ObjectCache.md#list) + +*** + +### off() + +#### Call Signature + +> **off**(`verb`, `cb`): `void` + +Defined in: [src/cache.ts:92](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L92) + +##### Parameters + +###### verb + +`"add"` \| `"update"` \| `"change"` \| `"delete"` + +###### cb + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\> + +##### Returns + +`void` + +##### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`off`](../../informer/interfaces/Informer.md#off) + +#### Call Signature + +> **off**(`verb`, `cb`): `void` + +Defined in: [src/cache.ts:93](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L93) + +##### Parameters + +###### verb + +`"connect"` \| `"error"` + +###### cb + +[`ErrorCallback`](../../informer/type-aliases/ErrorCallback.md) + +##### Returns + +`void` + +##### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`off`](../../informer/interfaces/Informer.md#off) + +*** + +### on() + +#### Call Signature + +> **on**(`verb`, `cb`): `void` + +Defined in: [src/cache.ts:74](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L74) + +##### Parameters + +###### verb + +`"add"` \| `"update"` \| `"change"` \| `"delete"` + +###### cb + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\> + +##### Returns + +`void` + +##### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`on`](../../informer/interfaces/Informer.md#on) + +#### Call Signature + +> **on**(`verb`, `cb`): `void` + +Defined in: [src/cache.ts:75](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L75) + +##### Parameters + +###### verb + +`"connect"` \| `"error"` + +###### cb + +[`ErrorCallback`](../../informer/type-aliases/ErrorCallback.md) + +##### Returns + +`void` + +##### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`on`](../../informer/interfaces/Informer.md#on) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [src/cache.ts:64](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L64) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`start`](../../informer/interfaces/Informer.md#start) + +*** + +### stop() + +> **stop**(): `Promise`\<`void`\> + +Defined in: [src/cache.ts:69](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L69) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Informer`](../../informer/interfaces/Informer.md).[`stop`](../../informer/interfaces/Informer.md#stop) diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/functions/addOrUpdateObject.md b/website/versioned_docs/version-2.0.0/sdk/cache/functions/addOrUpdateObject.md new file mode 100644 index 00000000000..4b78ada2d39 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cache/functions/addOrUpdateObject.md @@ -0,0 +1,33 @@ +# Function: addOrUpdateObject() + +> **addOrUpdateObject**\<`T`\>(`objects`, `obj`, `addCallbacks?`, `updateCallbacks?`): `void` + +Defined in: [src/cache.ts:296](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L296) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### objects + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +### obj + +`T` + +### addCallbacks? + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] + +### updateCallbacks? + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] + +## Returns + +`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/functions/cacheMapFromList.md b/website/versioned_docs/version-2.0.0/sdk/cache/functions/cacheMapFromList.md new file mode 100644 index 00000000000..9904d10b71a --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cache/functions/cacheMapFromList.md @@ -0,0 +1,21 @@ +# Function: cacheMapFromList() + +> **cacheMapFromList**\<`T`\>(`newObjects`): [`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +Defined in: [src/cache.ts:244](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L244) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### newObjects + +`T`[] + +## Returns + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteItems.md b/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteItems.md new file mode 100644 index 00000000000..4232db282dd --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteItems.md @@ -0,0 +1,29 @@ +# Function: deleteItems() + +> **deleteItems**\<`T`\>(`oldObjects`, `newObjects`, `deleteCallback?`): [`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +Defined in: [src/cache.ts:264](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L264) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### oldObjects + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +### newObjects + +`T`[] + +### deleteCallback? + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] + +## Returns + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteObject.md b/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteObject.md new file mode 100644 index 00000000000..a75cb3773e4 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteObject.md @@ -0,0 +1,29 @@ +# Function: deleteObject() + +> **deleteObject**\<`T`\>(`objects`, `obj`, `deleteCallbacks?`): `void` + +Defined in: [src/cache.ts:334](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L334) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### objects + +[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> + +### obj + +`T` + +### deleteCallbacks? + +[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] + +## Returns + +`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/index.md b/website/versioned_docs/version-2.0.0/sdk/cache/index.md new file mode 100644 index 00000000000..0ad962b28b3 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cache/index.md @@ -0,0 +1,20 @@ +# cache + +## Classes + +- [ListWatch](classes/ListWatch.md) + +## Interfaces + +- [ObjectCache](interfaces/ObjectCache.md) + +## Type Aliases + +- [CacheMap](type-aliases/CacheMap.md) + +## Functions + +- [addOrUpdateObject](functions/addOrUpdateObject.md) +- [cacheMapFromList](functions/cacheMapFromList.md) +- [deleteItems](functions/deleteItems.md) +- [deleteObject](functions/deleteObject.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/interfaces/ObjectCache.md b/website/versioned_docs/version-2.0.0/sdk/cache/interfaces/ObjectCache.md new file mode 100644 index 00000000000..be504bef243 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cache/interfaces/ObjectCache.md @@ -0,0 +1,49 @@ +# Interface: ObjectCache\ + +Defined in: [src/cache.ts:17](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L17) + +## Type Parameters + +### T + +`T` + +## Methods + +### get() + +> **get**(`name`, `namespace?`): `T` \| `undefined` + +Defined in: [src/cache.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L18) + +#### Parameters + +##### name + +`string` + +##### namespace? + +`string` + +#### Returns + +`T` \| `undefined` + +*** + +### list() + +> **list**(`namespace?`): readonly `T`[] + +Defined in: [src/cache.ts:20](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L20) + +#### Parameters + +##### namespace? + +`string` + +#### Returns + +readonly `T`[] diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/type-aliases/CacheMap.md b/website/versioned_docs/version-2.0.0/sdk/cache/type-aliases/CacheMap.md new file mode 100644 index 00000000000..1adf129fd77 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cache/type-aliases/CacheMap.md @@ -0,0 +1,11 @@ +# Type Alias: CacheMap\ + +> **CacheMap**\<`T`\> = `Map`\<`string`, `Map`\<`string`, `T`\>\> + +Defined in: [src/cache.ts:24](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L24) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/config/classes/KubeConfig.md b/website/versioned_docs/version-2.0.0/sdk/config/classes/KubeConfig.md new file mode 100644 index 00000000000..b39d1bb0df4 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/classes/KubeConfig.md @@ -0,0 +1,559 @@ +# Class: KubeConfig + +Defined in: [src/config.ts:68](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L68) + +## Implements + +- `SecurityAuthentication` + +## Constructors + +### Constructor + +> **new KubeConfig**(): `KubeConfig` + +Defined in: [src/config.ts:106](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L106) + +#### Returns + +`KubeConfig` + +## Properties + +### clusters + +> **clusters**: [`Cluster`](../../config_types/interfaces/Cluster.md)[] + +Defined in: [src/config.ts:89](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L89) + +The list of all known clusters + +*** + +### contexts + +> **contexts**: [`Context`](../../config_types/interfaces/Context.md)[] + +Defined in: [src/config.ts:99](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L99) + +The list of all known contexts + +*** + +### currentContext + +> **currentContext**: `string` + +Defined in: [src/config.ts:104](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L104) + +The name of the current context + +*** + +### users + +> **users**: [`User`](../../config_types/interfaces/User.md)[] + +Defined in: [src/config.ts:94](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L94) + +The list of all known users + +## Methods + +### addAuthenticator() + +> **addAuthenticator**(`authenticator`): `void` + +Defined in: [src/config.ts:82](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L82) + +#### Parameters + +##### authenticator + +`Authenticator` + +#### Returns + +`void` + +*** + +### addCluster() + +> **addCluster**(`cluster`): `void` + +Defined in: [src/config.ts:385](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L385) + +#### Parameters + +##### cluster + +[`Cluster`](../../config_types/interfaces/Cluster.md) + +#### Returns + +`void` + +*** + +### addContext() + +> **addContext**(`ctx`): `void` + +Defined in: [src/config.ts:409](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L409) + +#### Parameters + +##### ctx + +[`Context`](../../config_types/interfaces/Context.md) + +#### Returns + +`void` + +*** + +### addUser() + +> **addUser**(`user`): `void` + +Defined in: [src/config.ts:397](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L397) + +#### Parameters + +##### user + +[`User`](../../config_types/interfaces/User.md) + +#### Returns + +`void` + +*** + +### applySecurityAuthentication() + +> **applySecurityAuthentication**(`context`): `Promise`\<`void`\> + +Defined in: [src/config.ts:239](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L239) + +Applies SecurityAuthentication to RequestContext of an API Call from API Client + +#### Parameters + +##### context + +`RequestContext` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +`SecurityAuthentication.applySecurityAuthentication` + +*** + +### applyToFetchOptions() + +> **applyToFetchOptions**(`opts`): `Promise`\<`RequestInit`\> + +Defined in: [src/config.ts:169](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L169) + +#### Parameters + +##### opts + +`RequestOptions` + +#### Returns + +`Promise`\<`RequestInit`\> + +*** + +### applyToHTTPSOptions() + +> **applyToHTTPSOptions**(`opts`): `Promise`\<`void`\> + +Defined in: [src/config.ts:192](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L192) + +#### Parameters + +##### opts + +`any` + +#### Returns + +`Promise`\<`void`\> + +*** + +### exportConfig() + +> **exportConfig**(): `string` + +Defined in: [src/config.ts:526](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L526) + +#### Returns + +`string` + +*** + +### getCluster() + +> **getCluster**(`name`): [`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` + +Defined in: [src/config.ts:147](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L147) + +#### Parameters + +##### name + +`string` + +#### Returns + +[`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` + +*** + +### getClusters() + +> **getClusters**(): [`Cluster`](../../config_types/interfaces/Cluster.md)[] + +Defined in: [src/config.ts:116](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L116) + +#### Returns + +[`Cluster`](../../config_types/interfaces/Cluster.md)[] + +*** + +### getContextObject() + +> **getContextObject**(`name`): [`Context`](../../config_types/interfaces/Context.md) \| `null` + +Defined in: [src/config.ts:132](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L132) + +#### Parameters + +##### name + +`string` + +#### Returns + +[`Context`](../../config_types/interfaces/Context.md) \| `null` + +*** + +### getContexts() + +> **getContexts**(): [`Context`](../../config_types/interfaces/Context.md)[] + +Defined in: [src/config.ts:112](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L112) + +#### Returns + +[`Context`](../../config_types/interfaces/Context.md)[] + +*** + +### getCurrentCluster() + +> **getCurrentCluster**(): [`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` + +Defined in: [src/config.ts:139](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L139) + +#### Returns + +[`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` + +*** + +### getCurrentContext() + +> **getCurrentContext**(): `string` + +Defined in: [src/config.ts:124](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L124) + +#### Returns + +`string` + +*** + +### getCurrentUser() + +> **getCurrentUser**(): [`User`](../../config_types/interfaces/User.md) \| `null` + +Defined in: [src/config.ts:151](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L151) + +#### Returns + +[`User`](../../config_types/interfaces/User.md) \| `null` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: [src/config.ts:285](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L285) + +Returns name of this security authentication method + +#### Returns + +`string` + +string + +#### Implementation of + +`SecurityAuthentication.getName` + +*** + +### getUser() + +> **getUser**(`name`): [`User`](../../config_types/interfaces/User.md) \| `null` + +Defined in: [src/config.ts:159](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L159) + +#### Parameters + +##### name + +`string` + +#### Returns + +[`User`](../../config_types/interfaces/User.md) \| `null` + +*** + +### getUsers() + +> **getUsers**(): [`User`](../../config_types/interfaces/User.md)[] + +Defined in: [src/config.ts:120](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L120) + +#### Returns + +[`User`](../../config_types/interfaces/User.md)[] + +*** + +### loadFromCluster() + +> **loadFromCluster**(`pathPrefix?`): `void` + +Defined in: [src/config.ts:317](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L317) + +#### Parameters + +##### pathPrefix? + +`string` = `''` + +#### Returns + +`void` + +*** + +### loadFromClusterAndUser() + +> **loadFromClusterAndUser**(`cluster`, `user`): `void` + +Defined in: [src/config.ts:304](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L304) + +#### Parameters + +##### cluster + +[`Cluster`](../../config_types/interfaces/Cluster.md) + +##### user + +[`User`](../../config_types/interfaces/User.md) + +#### Returns + +`void` + +*** + +### loadFromDefault() + +> **loadFromDefault**(`opts?`, `contextFromStartingConfig?`, `platform?`): `void` + +Defined in: [src/config.ts:421](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L421) + +#### Parameters + +##### opts? + +`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> + +##### contextFromStartingConfig? + +`boolean` = `false` + +##### platform? + +`string` = `process.platform` + +#### Returns + +`void` + +*** + +### loadFromFile() + +> **loadFromFile**(`file`, `opts?`): `void` + +Defined in: [src/config.ts:163](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L163) + +#### Parameters + +##### file + +`string` + +##### opts? + +`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> + +#### Returns + +`void` + +*** + +### loadFromOptions() + +> **loadFromOptions**(`options`): `void` + +Defined in: [src/config.ts:297](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L297) + +#### Parameters + +##### options + +`any` + +#### Returns + +`void` + +*** + +### loadFromString() + +> **loadFromString**(`config`, `opts?`): `void` + +Defined in: [src/config.ts:289](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L289) + +#### Parameters + +##### config + +`string` + +##### opts? + +`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> + +#### Returns + +`void` + +*** + +### makeApiClient() + +> **makeApiClient**\<`T`\>(`apiClientType`): `T` + +Defined in: [src/config.ts:490](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L490) + +#### Type Parameters + +##### T + +`T` *extends* [`ApiType`](../interfaces/ApiType.md) + +#### Parameters + +##### apiClientType + +[`ApiConstructor`](../type-aliases/ApiConstructor.md)\<`T`\> + +#### Returns + +`T` + +*** + +### makePathsAbsolute() + +> **makePathsAbsolute**(`rootDirectory`): `void` + +Defined in: [src/config.ts:510](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L510) + +#### Parameters + +##### rootDirectory + +`string` + +#### Returns + +`void` + +*** + +### mergeConfig() + +> **mergeConfig**(`config`, `preserveContext?`): `void` + +Defined in: [src/config.ts:370](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L370) + +#### Parameters + +##### config + +`KubeConfig` + +##### preserveContext? + +`boolean` = `false` + +#### Returns + +`void` + +*** + +### setCurrentContext() + +> **setCurrentContext**(`context`): `void` + +Defined in: [src/config.ts:128](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L128) + +#### Parameters + +##### context + +`string` + +#### Returns + +`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/functions/bufferFromFileOrString.md b/website/versioned_docs/version-2.0.0/sdk/config/functions/bufferFromFileOrString.md new file mode 100644 index 00000000000..9ac103e5eba --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/functions/bufferFromFileOrString.md @@ -0,0 +1,19 @@ +# Function: bufferFromFileOrString() + +> **bufferFromFileOrString**(`file?`, `data?`): `Buffer` \| `null` + +Defined in: [src/config.ts:652](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L652) + +## Parameters + +### file? + +`string` + +### data? + +`string` + +## Returns + +`Buffer` \| `null` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/functions/findHomeDir.md b/website/versioned_docs/version-2.0.0/sdk/config/functions/findHomeDir.md new file mode 100644 index 00000000000..a27e33a38b6 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/functions/findHomeDir.md @@ -0,0 +1,15 @@ +# Function: findHomeDir() + +> **findHomeDir**(`platform?`): `string` \| `null` + +Defined in: [src/config.ts:675](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L675) + +## Parameters + +### platform? + +`string` = `process.platform` + +## Returns + +`string` \| `null` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/functions/findObject.md b/website/versioned_docs/version-2.0.0/sdk/config/functions/findObject.md new file mode 100644 index 00000000000..b0e9240bd22 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/functions/findObject.md @@ -0,0 +1,29 @@ +# Function: findObject() + +> **findObject**\<`T`\>(`list`, `name`, `key`): `T` \| `null` + +Defined in: [src/config.ts:734](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L734) + +## Type Parameters + +### T + +`T` *extends* [`Named`](../interfaces/Named.md) + +## Parameters + +### list + +`T`[] + +### name + +`string` + +### key + +`string` + +## Returns + +`T` \| `null` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/functions/makeAbsolutePath.md b/website/versioned_docs/version-2.0.0/sdk/config/functions/makeAbsolutePath.md new file mode 100644 index 00000000000..bba56827920 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/functions/makeAbsolutePath.md @@ -0,0 +1,19 @@ +# Function: makeAbsolutePath() + +> **makeAbsolutePath**(`root`, `file`): `string` + +Defined in: [src/config.ts:644](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L644) + +## Parameters + +### root + +`string` + +### file + +`string` + +## Returns + +`string` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/index.md b/website/versioned_docs/version-2.0.0/sdk/config/index.md new file mode 100644 index 00000000000..9b7c0e788d9 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/index.md @@ -0,0 +1,21 @@ +# config + +## Classes + +- [KubeConfig](classes/KubeConfig.md) + +## Interfaces + +- [ApiType](interfaces/ApiType.md) +- [Named](interfaces/Named.md) + +## Type Aliases + +- [ApiConstructor](type-aliases/ApiConstructor.md) + +## Functions + +- [bufferFromFileOrString](functions/bufferFromFileOrString.md) +- [findHomeDir](functions/findHomeDir.md) +- [findObject](functions/findObject.md) +- [makeAbsolutePath](functions/makeAbsolutePath.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/config/interfaces/ApiType.md b/website/versioned_docs/version-2.0.0/sdk/config/interfaces/ApiType.md new file mode 100644 index 00000000000..66d6a703b68 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/interfaces/ApiType.md @@ -0,0 +1,3 @@ +# Interface: ApiType + +Defined in: [src/config.ts:66](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L66) diff --git a/website/versioned_docs/version-2.0.0/sdk/config/interfaces/Named.md b/website/versioned_docs/version-2.0.0/sdk/config/interfaces/Named.md new file mode 100644 index 00000000000..092528f642f --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/interfaces/Named.md @@ -0,0 +1,11 @@ +# Interface: Named + +Defined in: [src/config.ts:729](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L729) + +## Properties + +### name + +> **name**: `string` + +Defined in: [src/config.ts:730](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L730) diff --git a/website/versioned_docs/version-2.0.0/sdk/config/type-aliases/ApiConstructor.md b/website/versioned_docs/version-2.0.0/sdk/config/type-aliases/ApiConstructor.md new file mode 100644 index 00000000000..150f0564e7d --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config/type-aliases/ApiConstructor.md @@ -0,0 +1,21 @@ +# Type Alias: ApiConstructor\ + +> **ApiConstructor**\<`T`\> = (`config`) => `T` + +Defined in: [src/config.ts:642](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L642) + +## Type Parameters + +### T + +`T` *extends* [`ApiType`](../interfaces/ApiType.md) + +## Parameters + +### config + +`Configuration` + +## Returns + +`T` diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportCluster.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportCluster.md new file mode 100644 index 00000000000..496ceff3a0a --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportCluster.md @@ -0,0 +1,15 @@ +# Function: exportCluster() + +> **exportCluster**(`cluster`): `any` + +Defined in: [src/config\_types.ts:40](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L40) + +## Parameters + +### cluster + +[`Cluster`](../interfaces/Cluster.md) + +## Returns + +`any` diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportContext.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportContext.md new file mode 100644 index 00000000000..db1af685fd2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportContext.md @@ -0,0 +1,15 @@ +# Function: exportContext() + +> **exportContext**(`ctx`): `any` + +Defined in: [src/config\_types.ts:190](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L190) + +## Parameters + +### ctx + +[`Context`](../interfaces/Context.md) + +## Returns + +`any` diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportUser.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportUser.md new file mode 100644 index 00000000000..7f63b738075 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportUser.md @@ -0,0 +1,15 @@ +# Function: exportUser() + +> **exportUser**(`user`): `any` + +Defined in: [src/config\_types.ts:113](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L113) + +## Parameters + +### user + +[`User`](../interfaces/User.md) + +## Returns + +`any` diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newClusters.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newClusters.md new file mode 100644 index 00000000000..5e848e742ca --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newClusters.md @@ -0,0 +1,19 @@ +# Function: newClusters() + +> **newClusters**(`a`, `opts?`): [`Cluster`](../interfaces/Cluster.md)[] + +Defined in: [src/config\_types.ts:30](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L30) + +## Parameters + +### a + +`any` + +### opts? + +`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> + +## Returns + +[`Cluster`](../interfaces/Cluster.md)[] diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newContexts.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newContexts.md new file mode 100644 index 00000000000..6157eb0b7f8 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newContexts.md @@ -0,0 +1,19 @@ +# Function: newContexts() + +> **newContexts**(`a`, `opts?`): [`Context`](../interfaces/Context.md)[] + +Defined in: [src/config\_types.ts:180](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L180) + +## Parameters + +### a + +`any` + +### opts? + +`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> + +## Returns + +[`Context`](../interfaces/Context.md)[] diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newUsers.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newUsers.md new file mode 100644 index 00000000000..c6de2ceb5dc --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newUsers.md @@ -0,0 +1,19 @@ +# Function: newUsers() + +> **newUsers**(`a`, `opts?`): [`User`](../interfaces/User.md)[] + +Defined in: [src/config\_types.ts:103](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L103) + +## Parameters + +### a + +`any` + +### opts? + +`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> + +## Returns + +[`User`](../interfaces/User.md)[] diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/index.md b/website/versioned_docs/version-2.0.0/sdk/config_types/index.md new file mode 100644 index 00000000000..35ebc25425d --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/index.md @@ -0,0 +1,25 @@ +# config\_types + +## Interfaces + +- [Cluster](interfaces/Cluster.md) +- [ConfigOptions](interfaces/ConfigOptions.md) +- [Context](interfaces/Context.md) +- [User](interfaces/User.md) + +## Type Aliases + +- [ActionOnInvalid](type-aliases/ActionOnInvalid.md) + +## Variables + +- [ActionOnInvalid](variables/ActionOnInvalid.md) + +## Functions + +- [exportCluster](functions/exportCluster.md) +- [exportContext](functions/exportContext.md) +- [exportUser](functions/exportUser.md) +- [newClusters](functions/newClusters.md) +- [newContexts](functions/newContexts.md) +- [newUsers](functions/newUsers.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Cluster.md b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Cluster.md new file mode 100644 index 00000000000..47e14cc8463 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Cluster.md @@ -0,0 +1,59 @@ +# Interface: Cluster + +Defined in: [src/config\_types.ts:20](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L20) + +## Properties + +### caData? + +> `readonly` `optional` **caData?**: `string` + +Defined in: [src/config\_types.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L22) + +*** + +### caFile? + +> `optional` **caFile?**: `string` + +Defined in: [src/config\_types.ts:23](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L23) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: [src/config\_types.ts:21](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L21) + +*** + +### proxyUrl? + +> `readonly` `optional` **proxyUrl?**: `string` + +Defined in: [src/config\_types.ts:27](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L27) + +*** + +### server + +> `readonly` **server**: `string` + +Defined in: [src/config\_types.ts:24](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L24) + +*** + +### skipTLSVerify + +> `readonly` **skipTLSVerify**: `boolean` + +Defined in: [src/config\_types.ts:26](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L26) + +*** + +### tlsServerName? + +> `readonly` `optional` **tlsServerName?**: `string` + +Defined in: [src/config\_types.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L25) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/ConfigOptions.md b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/ConfigOptions.md new file mode 100644 index 00000000000..2869f14d516 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/ConfigOptions.md @@ -0,0 +1,11 @@ +# Interface: ConfigOptions + +Defined in: [src/config\_types.ts:10](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L10) + +## Properties + +### onInvalidEntry + +> **onInvalidEntry**: [`ActionOnInvalid`](../type-aliases/ActionOnInvalid.md) + +Defined in: [src/config\_types.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L11) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Context.md b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Context.md new file mode 100644 index 00000000000..809b0be41ff --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Context.md @@ -0,0 +1,35 @@ +# Interface: Context + +Defined in: [src/config\_types.ts:173](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L173) + +## Properties + +### cluster + +> `readonly` **cluster**: `string` + +Defined in: [src/config\_types.ts:174](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L174) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: [src/config\_types.ts:176](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L176) + +*** + +### namespace? + +> `readonly` `optional` **namespace?**: `string` + +Defined in: [src/config\_types.ts:177](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L177) + +*** + +### user + +> `readonly` **user**: `string` + +Defined in: [src/config\_types.ts:175](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L175) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/User.md b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/User.md new file mode 100644 index 00000000000..cc1e323b482 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/User.md @@ -0,0 +1,91 @@ +# Interface: User + +Defined in: [src/config\_types.ts:89](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L89) + +## Properties + +### authProvider? + +> `readonly` `optional` **authProvider?**: `any` + +Defined in: [src/config\_types.ts:96](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L96) + +*** + +### certData? + +> `readonly` `optional` **certData?**: `string` + +Defined in: [src/config\_types.ts:91](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L91) + +*** + +### certFile? + +> `optional` **certFile?**: `string` + +Defined in: [src/config\_types.ts:92](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L92) + +*** + +### exec? + +> `readonly` `optional` **exec?**: `any` + +Defined in: [src/config\_types.ts:93](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L93) + +*** + +### impersonateUser? + +> `readonly` `optional` **impersonateUser?**: `string` + +Defined in: [src/config\_types.ts:100](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L100) + +*** + +### keyData? + +> `readonly` `optional` **keyData?**: `string` + +Defined in: [src/config\_types.ts:94](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L94) + +*** + +### keyFile? + +> `optional` **keyFile?**: `string` + +Defined in: [src/config\_types.ts:95](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L95) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: [src/config\_types.ts:90](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L90) + +*** + +### password? + +> `readonly` `optional` **password?**: `string` + +Defined in: [src/config\_types.ts:99](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L99) + +*** + +### token? + +> `readonly` `optional` **token?**: `string` + +Defined in: [src/config\_types.ts:97](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L97) + +*** + +### username? + +> `readonly` `optional` **username?**: `string` + +Defined in: [src/config\_types.ts:98](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L98) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/type-aliases/ActionOnInvalid.md b/website/versioned_docs/version-2.0.0/sdk/config_types/type-aliases/ActionOnInvalid.md new file mode 100644 index 00000000000..028306a1640 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/type-aliases/ActionOnInvalid.md @@ -0,0 +1,5 @@ +# Type Alias: ActionOnInvalid + +> **ActionOnInvalid** = *typeof* [`ActionOnInvalid`](../variables/ActionOnInvalid.md)\[keyof *typeof* [`ActionOnInvalid`](../variables/ActionOnInvalid.md)\] + +Defined in: [src/config\_types.ts:3](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L3) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/variables/ActionOnInvalid.md b/website/versioned_docs/version-2.0.0/sdk/config_types/variables/ActionOnInvalid.md new file mode 100644 index 00000000000..d41d241903c --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/config_types/variables/ActionOnInvalid.md @@ -0,0 +1,15 @@ +# Variable: ActionOnInvalid + +> `const` **ActionOnInvalid**: `object` + +Defined in: [src/config\_types.ts:3](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L3) + +## Type Declaration + +### FILTER + +> `readonly` **FILTER**: `"filter"` = `'filter'` + +### THROW + +> `readonly` **THROW**: `"throw"` = `'throw'` diff --git a/website/versioned_docs/version-2.0.0/sdk/cp/classes/Cp.md b/website/versioned_docs/version-2.0.0/sdk/cp/classes/Cp.md new file mode 100644 index 00000000000..e5f698eb5d5 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cp/classes/Cp.md @@ -0,0 +1,127 @@ +# Class: Cp + +Defined in: [src/cp.ts:7](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L7) + +## Constructors + +### Constructor + +> **new Cp**(`config`, `execInstance?`): `Cp` + +Defined in: [src/cp.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L9) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +##### execInstance? + +[`Exec`](../../exec/classes/Exec.md) + +#### Returns + +`Cp` + +## Properties + +### execInstance + +> **execInstance**: [`Exec`](../../exec/classes/Exec.md) + +Defined in: [src/cp.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L8) + +## Methods + +### cpFromPod() + +> **cpFromPod**(`namespace`, `podName`, `containerName`, `srcPath`, `tgtPath`, `cwd?`): `Promise`\<`void`\> + +Defined in: [src/cp.ts:21](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L21) + +#### Parameters + +##### namespace + +`string` + +The namespace of the pod to exec the command inside. + +##### podName + +`string` + +The name of the pod to exec the command inside. + +##### containerName + +`string` + +The name of the container in the pod to exec the command inside. + +##### srcPath + +`string` + +The source path in the pod + +##### tgtPath + +`string` + +The target path in local + +##### cwd? + +`string` + +The directory that is used as the parent in the pod when downloading + +#### Returns + +`Promise`\<`void`\> + +*** + +### cpToPod() + +> **cpToPod**(`namespace`, `podName`, `containerName`, `srcPath`, `tgtPath`): `Promise`\<`void`\> + +Defined in: [src/cp.ts:60](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L60) + +#### Parameters + +##### namespace + +`string` + +The namespace of the pod to exec the command inside. + +##### podName + +`string` + +The name of the pod to exec the command inside. + +##### containerName + +`string` + +The name of the container in the pod to exec the command inside. + +##### srcPath + +`string` + +The source path in local + +##### tgtPath + +`string` + +The target path in the pod + +#### Returns + +`Promise`\<`void`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/cp/index.md b/website/versioned_docs/version-2.0.0/sdk/cp/index.md new file mode 100644 index 00000000000..67baee4077a --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/cp/index.md @@ -0,0 +1,5 @@ +# cp + +## Classes + +- [Cp](classes/Cp.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/exec/classes/Exec.md b/website/versioned_docs/version-2.0.0/sdk/exec/classes/Exec.md new file mode 100644 index 00000000000..121681e46fb --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/exec/classes/Exec.md @@ -0,0 +1,103 @@ +# Class: Exec + +Defined in: [src/exec.ts:10](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/exec.ts#L10) + +## Constructors + +### Constructor + +> **new Exec**(`config`, `wsInterface?`): `Exec` + +Defined in: [src/exec.ts:15](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/exec.ts#L15) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +##### wsInterface? + +`WebSocketInterface` + +#### Returns + +`Exec` + +## Properties + +### handler + +> **handler**: `WebSocketInterface` + +Defined in: [src/exec.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/exec.ts#L11) + +## Methods + +### exec() + +> **exec**(`namespace`, `podName`, `containerName`, `command`, `stdout`, `stderr`, `stdin`, `tty`, `statusCallback?`): `Promise`\<`WebSocket`\> + +Defined in: [src/exec.ts:32](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/exec.ts#L32) + +#### Parameters + +##### namespace + +`string` + +The namespace of the pod to exec the command inside. + +##### podName + +`string` + +The name of the pod to exec the command inside. + +##### containerName + +`string` + +The name of the container in the pod to exec the command inside. + +##### command + +`string` \| `string`[] + +The command or command and arguments to execute. + +##### stdout + +`Writable` \| `null` + +The stream to write stdout data from the command. + +##### stderr + +`Writable` \| `null` + +The stream to write stderr data from the command. + +##### stdin + +`Readable` \| `null` + +The stream to write stdin data into the command. + +##### tty + +`boolean` + +Should the command execute in a TTY enabled session. + +##### statusCallback? + +(`status`) => `void` + +A callback to received the status (e.g. exit code) from the command, optional. + +#### Returns + +`Promise`\<`WebSocket`\> + +A promise that will return the web socket created for this command. diff --git a/website/versioned_docs/version-2.0.0/sdk/exec/index.md b/website/versioned_docs/version-2.0.0/sdk/exec/index.md new file mode 100644 index 00000000000..84d31a7aad2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/exec/index.md @@ -0,0 +1,5 @@ +# exec + +## Classes + +- [Exec](classes/Exec.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/health/classes/Health.md b/website/versioned_docs/version-2.0.0/sdk/health/classes/Health.md new file mode 100644 index 00000000000..a258ccfa9b3 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/health/classes/Health.md @@ -0,0 +1,65 @@ +# Class: Health + +Defined in: [src/health.ts:5](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L5) + +## Constructors + +### Constructor + +> **new Health**(`config`): `Health` + +Defined in: [src/health.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L8) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +#### Returns + +`Health` + +## Properties + +### config + +> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) + +Defined in: [src/health.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L6) + +## Methods + +### livez() + +> **livez**(`opts`): `Promise`\<`boolean`\> + +Defined in: [src/health.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L16) + +#### Parameters + +##### opts + +`RequestOptions` + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### readyz() + +> **readyz**(`opts`): `Promise`\<`boolean`\> + +Defined in: [src/health.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L12) + +#### Parameters + +##### opts + +`RequestOptions` + +#### Returns + +`Promise`\<`boolean`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/health/index.md b/website/versioned_docs/version-2.0.0/sdk/health/index.md new file mode 100644 index 00000000000..ee17d9e0f20 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/health/index.md @@ -0,0 +1,5 @@ +# health + +## Classes + +- [Health](classes/Health.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/index.md b/website/versioned_docs/version-2.0.0/sdk/index.md new file mode 100644 index 00000000000..206b899986f --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/index.md @@ -0,0 +1,22 @@ +# @kubernetes/client-node + +## Modules + +- [attach](attach/index.md) +- [cache](cache/index.md) +- [config](config/index.md) +- [config\_types](config_types/index.md) +- [cp](cp/index.md) +- [exec](exec/index.md) +- [health](health/index.md) +- [informer](informer/index.md) +- [log](log/index.md) +- [metrics](metrics/index.md) +- [middleware](middleware/index.md) +- [object](object/index.md) +- [patch](patch/index.md) +- [portforward](portforward/index.md) +- [top](top/index.md) +- [types](types/index.md) +- [watch](watch/index.md) +- [yaml](yaml/index.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/functions/makeInformer.md b/website/versioned_docs/version-2.0.0/sdk/informer/functions/makeInformer.md new file mode 100644 index 00000000000..18a75355eaa --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/functions/makeInformer.md @@ -0,0 +1,33 @@ +# Function: makeInformer() + +> **makeInformer**\<`T`\>(`kubeconfig`, `path`, `listPromiseFn`, `labelSelector?`): [`Informer`](../interfaces/Informer.md)\<`T`\> & [`ObjectCache`](../../cache/interfaces/ObjectCache.md)\<`T`\> + +Defined in: [src/informer.ts:37](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L37) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### kubeconfig + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +### path + +`string` + +### listPromiseFn + +[`ListPromise`](../type-aliases/ListPromise.md)\<`T`\> + +### labelSelector? + +`string` + +## Returns + +[`Informer`](../interfaces/Informer.md)\<`T`\> & [`ObjectCache`](../../cache/interfaces/ObjectCache.md)\<`T`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/index.md b/website/versioned_docs/version-2.0.0/sdk/informer/index.md new file mode 100644 index 00000000000..b8b436f663a --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/index.md @@ -0,0 +1,31 @@ +# informer + +## Interfaces + +- [Informer](interfaces/Informer.md) + +## Type Aliases + +- [ADD](type-aliases/ADD.md) +- [CHANGE](type-aliases/CHANGE.md) +- [CONNECT](type-aliases/CONNECT.md) +- [DELETE](type-aliases/DELETE.md) +- [ERROR](type-aliases/ERROR.md) +- [ErrorCallback](type-aliases/ErrorCallback.md) +- [ListCallback](type-aliases/ListCallback.md) +- [ListPromise](type-aliases/ListPromise.md) +- [ObjectCallback](type-aliases/ObjectCallback.md) +- [UPDATE](type-aliases/UPDATE.md) + +## Variables + +- [ADD](variables/ADD.md) +- [CHANGE](variables/CHANGE.md) +- [CONNECT](variables/CONNECT.md) +- [DELETE](variables/DELETE.md) +- [ERROR](variables/ERROR.md) +- [UPDATE](variables/UPDATE.md) + +## Functions + +- [makeInformer](functions/makeInformer.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/interfaces/Informer.md b/website/versioned_docs/version-2.0.0/sdk/informer/interfaces/Informer.md new file mode 100644 index 00000000000..81bd4c3ed86 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/interfaces/Informer.md @@ -0,0 +1,121 @@ +# Interface: Informer\ + +Defined in: [src/informer.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L28) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Methods + +### off() + +#### Call Signature + +> **off**(`verb`, `cb`): `void` + +Defined in: [src/informer.ts:31](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L31) + +##### Parameters + +###### verb + +`"add"` \| `"update"` \| `"change"` \| `"delete"` + +###### cb + +[`ObjectCallback`](../type-aliases/ObjectCallback.md)\<`T`\> + +##### Returns + +`void` + +#### Call Signature + +> **off**(`verb`, `cb`): `void` + +Defined in: [src/informer.ts:32](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L32) + +##### Parameters + +###### verb + +`"connect"` \| `"error"` + +###### cb + +[`ErrorCallback`](../type-aliases/ErrorCallback.md) + +##### Returns + +`void` + +*** + +### on() + +#### Call Signature + +> **on**(`verb`, `cb`): `void` + +Defined in: [src/informer.ts:29](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L29) + +##### Parameters + +###### verb + +`"add"` \| `"update"` \| `"change"` \| `"delete"` + +###### cb + +[`ObjectCallback`](../type-aliases/ObjectCallback.md)\<`T`\> + +##### Returns + +`void` + +#### Call Signature + +> **on**(`verb`, `cb`): `void` + +Defined in: [src/informer.ts:30](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L30) + +##### Parameters + +###### verb + +`"connect"` \| `"error"` + +###### cb + +[`ErrorCallback`](../type-aliases/ErrorCallback.md) + +##### Returns + +`void` + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [src/informer.ts:33](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L33) + +#### Returns + +`Promise`\<`void`\> + +*** + +### stop() + +> **stop**(): `Promise`\<`void`\> + +Defined in: [src/informer.ts:34](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L34) + +#### Returns + +`Promise`\<`void`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ADD.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ADD.md new file mode 100644 index 00000000000..0107347e998 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ADD.md @@ -0,0 +1,5 @@ +# Type Alias: ADD + +> **ADD** = *typeof* [`ADD`](../variables/ADD.md) + +Defined in: [src/informer.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L12) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CHANGE.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CHANGE.md new file mode 100644 index 00000000000..49048593132 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CHANGE.md @@ -0,0 +1,5 @@ +# Type Alias: CHANGE + +> **CHANGE** = *typeof* [`CHANGE`](../variables/CHANGE.md) + +Defined in: [src/informer.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L16) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CONNECT.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CONNECT.md new file mode 100644 index 00000000000..cbc095cf9e9 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CONNECT.md @@ -0,0 +1,5 @@ +# Type Alias: CONNECT + +> **CONNECT** = *typeof* [`CONNECT`](../variables/CONNECT.md) + +Defined in: [src/informer.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L22) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/DELETE.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/DELETE.md new file mode 100644 index 00000000000..e6376538bb5 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/DELETE.md @@ -0,0 +1,5 @@ +# Type Alias: DELETE + +> **DELETE** = *typeof* [`DELETE`](../variables/DELETE.md) + +Defined in: [src/informer.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L18) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ERROR.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ERROR.md new file mode 100644 index 00000000000..42123e01c3b --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ERROR.md @@ -0,0 +1,5 @@ +# Type Alias: ERROR + +> **ERROR** = *typeof* [`ERROR`](../variables/ERROR.md) + +Defined in: [src/informer.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L25) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ErrorCallback.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ErrorCallback.md new file mode 100644 index 00000000000..fe41f7e4a22 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ErrorCallback.md @@ -0,0 +1,15 @@ +# Type Alias: ErrorCallback + +> **ErrorCallback** = (`err?`) => `void` + +Defined in: [src/informer.ts:7](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L7) + +## Parameters + +### err? + +`any` + +## Returns + +`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListCallback.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListCallback.md new file mode 100644 index 00000000000..6eadafcd6f3 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListCallback.md @@ -0,0 +1,25 @@ +# Type Alias: ListCallback\ + +> **ListCallback**\<`T`\> = (`list`, `ResourceVersion`) => `void` + +Defined in: [src/informer.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L8) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### list + +`T`[] + +### ResourceVersion + +`string` + +## Returns + +`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListPromise.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListPromise.md new file mode 100644 index 00000000000..947561b43b2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListPromise.md @@ -0,0 +1,15 @@ +# Type Alias: ListPromise\ + +> **ListPromise**\<`T`\> = () => `Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> + +Defined in: [src/informer.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L9) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Returns + +`Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ObjectCallback.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ObjectCallback.md new file mode 100644 index 00000000000..d95dc7d57e2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ObjectCallback.md @@ -0,0 +1,21 @@ +# Type Alias: ObjectCallback\ + +> **ObjectCallback**\<`T`\> = (`obj`) => `void` + +Defined in: [src/informer.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L6) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +## Parameters + +### obj + +`T` + +## Returns + +`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/UPDATE.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/UPDATE.md new file mode 100644 index 00000000000..00e792210e4 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/UPDATE.md @@ -0,0 +1,5 @@ +# Type Alias: UPDATE + +> **UPDATE** = *typeof* [`UPDATE`](../variables/UPDATE.md) + +Defined in: [src/informer.ts:14](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L14) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/ADD.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/ADD.md new file mode 100644 index 00000000000..e48e8fea6ad --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/variables/ADD.md @@ -0,0 +1,5 @@ +# Variable: ADD + +> `const` **ADD**: `"add"` = `'add'` + +Defined in: [src/informer.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L12) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/CHANGE.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/CHANGE.md new file mode 100644 index 00000000000..d3415f562dc --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/variables/CHANGE.md @@ -0,0 +1,5 @@ +# Variable: CHANGE + +> `const` **CHANGE**: `"change"` = `'change'` + +Defined in: [src/informer.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L16) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/CONNECT.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/CONNECT.md new file mode 100644 index 00000000000..0ddbe5e4c90 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/variables/CONNECT.md @@ -0,0 +1,5 @@ +# Variable: CONNECT + +> `const` **CONNECT**: `"connect"` = `'connect'` + +Defined in: [src/informer.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L22) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/DELETE.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/DELETE.md new file mode 100644 index 00000000000..2c609f84aa1 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/variables/DELETE.md @@ -0,0 +1,5 @@ +# Variable: DELETE + +> `const` **DELETE**: `"delete"` = `'delete'` + +Defined in: [src/informer.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L18) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/ERROR.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/ERROR.md new file mode 100644 index 00000000000..1e9be8bf66d --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/variables/ERROR.md @@ -0,0 +1,5 @@ +# Variable: ERROR + +> `const` **ERROR**: `"error"` = `'error'` + +Defined in: [src/informer.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L25) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/UPDATE.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/UPDATE.md new file mode 100644 index 00000000000..eb3ce387be5 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/informer/variables/UPDATE.md @@ -0,0 +1,5 @@ +# Variable: UPDATE + +> `const` **UPDATE**: `"update"` = `'update'` + +Defined in: [src/informer.ts:14](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L14) diff --git a/website/versioned_docs/version-2.0.0/sdk/log/classes/Log.md b/website/versioned_docs/version-2.0.0/sdk/log/classes/Log.md new file mode 100644 index 00000000000..f1b4e2310b1 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/log/classes/Log.md @@ -0,0 +1,105 @@ +# Class: Log + +Defined in: [src/log.ts:84](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L84) + +## Constructors + +### Constructor + +> **new Log**(`config`): `Log` + +Defined in: [src/log.ts:87](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L87) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +#### Returns + +`Log` + +## Properties + +### config + +> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) + +Defined in: [src/log.ts:85](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L85) + +## Methods + +### log() + +#### Call Signature + +> **log**(`namespace`, `podName`, `containerName`, `stream`, `options?`): `Promise`\<`AbortController`\> + +Defined in: [src/log.ts:91](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L91) + +##### Parameters + +###### namespace + +`string` + +###### podName + +`string` + +###### containerName + +`string` + +###### stream + +`Writable` + +###### options? + +[`LogOptions`](../interfaces/LogOptions.md) + +##### Returns + +`Promise`\<`AbortController`\> + +#### Call Signature + +> **log**(`namespace`, `podName`, `containerName`, `stream`, `done`, `options?`): `Promise`\<`AbortController`\> + +Defined in: [src/log.ts:99](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L99) + +##### Parameters + +###### namespace + +`string` + +###### podName + +`string` + +###### containerName + +`string` + +###### stream + +`Writable` + +###### done + +(`err`) => `void` + +###### options? + +[`LogOptions`](../interfaces/LogOptions.md) + +##### Returns + +`Promise`\<`AbortController`\> + +##### Deprecated + +done callback is deprecated diff --git a/website/versioned_docs/version-2.0.0/sdk/log/functions/AddOptionsToSearchParams.md b/website/versioned_docs/version-2.0.0/sdk/log/functions/AddOptionsToSearchParams.md new file mode 100644 index 00000000000..654abbab248 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/log/functions/AddOptionsToSearchParams.md @@ -0,0 +1,19 @@ +# Function: AddOptionsToSearchParams() + +> **AddOptionsToSearchParams**(`options`, `searchParams`): `URLSearchParams` \| `undefined` + +Defined in: [src/log.ts:55](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L55) + +## Parameters + +### options + +[`LogOptions`](../interfaces/LogOptions.md) \| `undefined` + +### searchParams + +`URLSearchParams` + +## Returns + +`URLSearchParams` \| `undefined` diff --git a/website/versioned_docs/version-2.0.0/sdk/log/index.md b/website/versioned_docs/version-2.0.0/sdk/log/index.md new file mode 100644 index 00000000000..fd0405bfa4d --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/log/index.md @@ -0,0 +1,13 @@ +# log + +## Classes + +- [Log](classes/Log.md) + +## Interfaces + +- [LogOptions](interfaces/LogOptions.md) + +## Functions + +- [AddOptionsToSearchParams](functions/AddOptionsToSearchParams.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/log/interfaces/LogOptions.md b/website/versioned_docs/version-2.0.0/sdk/log/interfaces/LogOptions.md new file mode 100644 index 00000000000..7428d8fc48d --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/log/interfaces/LogOptions.md @@ -0,0 +1,88 @@ +# Interface: LogOptions + +Defined in: [src/log.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L8) + +## Properties + +### follow? + +> `optional` **follow?**: `boolean` + +Defined in: [src/log.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L12) + +Follow the log stream of the pod. Defaults to false. + +*** + +### limitBytes? + +> `optional` **limitBytes?**: `number` + +Defined in: [src/log.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L18) + +If set, the number of bytes to read from the server before terminating the log output. This may not display a +complete final line of logging, and may return slightly more or slightly less than the specified limit. + +*** + +### pretty? + +> `optional` **pretty?**: `boolean` + +Defined in: [src/log.ts:23](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L23) + +If true, then the output is pretty printed. + +*** + +### previous? + +> `optional` **previous?**: `boolean` + +Defined in: [src/log.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L28) + +Return previous terminated container logs. Defaults to false. + +*** + +### sinceSeconds? + +> `optional` **sinceSeconds?**: `number` + +Defined in: [src/log.ts:35](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L35) + +A relative time in seconds before the current time from which to show logs. If this value precedes the time a +pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will +be returned. Only one of sinceSeconds or sinceTime may be specified. + +*** + +### sinceTime? + +> `optional` **sinceTime?**: `string` + +Defined in: [src/log.ts:41](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L41) + +Only return logs after a specific date (RFC3339). Defaults to all logs. +Only one of sinceSeconds or sinceTime may be specified. + +*** + +### tailLines? + +> `optional` **tailLines?**: `number` + +Defined in: [src/log.ts:47](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L47) + +If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation +of the container or sinceSeconds or sinceTime + +*** + +### timestamps? + +> `optional` **timestamps?**: `boolean` + +Defined in: [src/log.ts:52](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L52) + +If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/classes/Metrics.md b/website/versioned_docs/version-2.0.0/sdk/metrics/classes/Metrics.md new file mode 100644 index 00000000000..9014336e2cc --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/metrics/classes/Metrics.md @@ -0,0 +1,51 @@ +# Class: Metrics + +Defined in: [src/metrics.ts:57](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L57) + +## Constructors + +### Constructor + +> **new Metrics**(`config`): `Metrics` + +Defined in: [src/metrics.ts:60](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L60) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +#### Returns + +`Metrics` + +## Methods + +### getNodeMetrics() + +> **getNodeMetrics**(): `Promise`\<[`NodeMetricsList`](../interfaces/NodeMetricsList.md)\> + +Defined in: [src/metrics.ts:64](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L64) + +#### Returns + +`Promise`\<[`NodeMetricsList`](../interfaces/NodeMetricsList.md)\> + +*** + +### getPodMetrics() + +> **getPodMetrics**(`namespace?`): `Promise`\<[`PodMetricsList`](../interfaces/PodMetricsList.md)\> + +Defined in: [src/metrics.ts:68](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L68) + +#### Parameters + +##### namespace? + +`string` + +#### Returns + +`Promise`\<[`PodMetricsList`](../interfaces/PodMetricsList.md)\> diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/index.md b/website/versioned_docs/version-2.0.0/sdk/metrics/index.md new file mode 100644 index 00000000000..21d120f931e --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/metrics/index.md @@ -0,0 +1,14 @@ +# metrics + +## Classes + +- [Metrics](classes/Metrics.md) + +## Interfaces + +- [ContainerMetric](interfaces/ContainerMetric.md) +- [NodeMetric](interfaces/NodeMetric.md) +- [NodeMetricsList](interfaces/NodeMetricsList.md) +- [PodMetric](interfaces/PodMetric.md) +- [PodMetricsList](interfaces/PodMetricsList.md) +- [Usage](interfaces/Usage.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/ContainerMetric.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/ContainerMetric.md new file mode 100644 index 00000000000..afded7d7caa --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/ContainerMetric.md @@ -0,0 +1,19 @@ +# Interface: ContainerMetric + +Defined in: [src/metrics.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L11) + +## Properties + +### name + +> **name**: `string` + +Defined in: [src/metrics.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L12) + +*** + +### usage + +> **usage**: [`Usage`](Usage.md) + +Defined in: [src/metrics.ts:13](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L13) diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetric.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetric.md new file mode 100644 index 00000000000..fc4d43622ec --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetric.md @@ -0,0 +1,47 @@ +# Interface: NodeMetric + +Defined in: [src/metrics.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L28) + +## Properties + +### metadata + +> **metadata**: `object` + +Defined in: [src/metrics.ts:29](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L29) + +#### creationTimestamp + +> **creationTimestamp**: `string` + +#### name + +> **name**: `string` + +#### selfLink + +> **selfLink**: `string` + +*** + +### timestamp + +> **timestamp**: `string` + +Defined in: [src/metrics.ts:34](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L34) + +*** + +### usage + +> **usage**: [`Usage`](Usage.md) + +Defined in: [src/metrics.ts:36](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L36) + +*** + +### window + +> **window**: `string` + +Defined in: [src/metrics.ts:35](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L35) diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetricsList.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetricsList.md new file mode 100644 index 00000000000..73266758061 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetricsList.md @@ -0,0 +1,39 @@ +# Interface: NodeMetricsList + +Defined in: [src/metrics.ts:48](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L48) + +## Properties + +### apiVersion + +> **apiVersion**: `"metrics.k8s.io/v1beta1"` + +Defined in: [src/metrics.ts:50](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L50) + +*** + +### items + +> **items**: [`NodeMetric`](NodeMetric.md)[] + +Defined in: [src/metrics.ts:54](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L54) + +*** + +### kind + +> **kind**: `"NodeMetricsList"` + +Defined in: [src/metrics.ts:49](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L49) + +*** + +### metadata + +> **metadata**: `object` + +Defined in: [src/metrics.ts:51](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L51) + +#### selfLink + +> **selfLink**: `string` diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetric.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetric.md new file mode 100644 index 00000000000..0cf3af5384c --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetric.md @@ -0,0 +1,51 @@ +# Interface: PodMetric + +Defined in: [src/metrics.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L16) + +## Properties + +### containers + +> **containers**: [`ContainerMetric`](ContainerMetric.md)[] + +Defined in: [src/metrics.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L25) + +*** + +### metadata + +> **metadata**: `object` + +Defined in: [src/metrics.ts:17](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L17) + +#### creationTimestamp + +> **creationTimestamp**: `string` + +#### name + +> **name**: `string` + +#### namespace + +> **namespace**: `string` + +#### selfLink + +> **selfLink**: `string` + +*** + +### timestamp + +> **timestamp**: `string` + +Defined in: [src/metrics.ts:23](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L23) + +*** + +### window + +> **window**: `string` + +Defined in: [src/metrics.ts:24](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L24) diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetricsList.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetricsList.md new file mode 100644 index 00000000000..5a3bd59ebc0 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetricsList.md @@ -0,0 +1,39 @@ +# Interface: PodMetricsList + +Defined in: [src/metrics.ts:39](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L39) + +## Properties + +### apiVersion + +> **apiVersion**: `"metrics.k8s.io/v1beta1"` + +Defined in: [src/metrics.ts:41](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L41) + +*** + +### items + +> **items**: [`PodMetric`](PodMetric.md)[] + +Defined in: [src/metrics.ts:45](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L45) + +*** + +### kind + +> **kind**: `"PodMetricsList"` + +Defined in: [src/metrics.ts:40](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L40) + +*** + +### metadata + +> **metadata**: `object` + +Defined in: [src/metrics.ts:42](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L42) + +#### selfLink + +> **selfLink**: `string` diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/Usage.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/Usage.md new file mode 100644 index 00000000000..5c196e5885f --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/Usage.md @@ -0,0 +1,19 @@ +# Interface: Usage + +Defined in: [src/metrics.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L6) + +## Properties + +### cpu + +> **cpu**: `string` + +Defined in: [src/metrics.ts:7](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L7) + +*** + +### memory + +> **memory**: `string` + +Defined in: [src/metrics.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L8) diff --git a/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderMiddleware.md b/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderMiddleware.md new file mode 100644 index 00000000000..c2354765ba2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderMiddleware.md @@ -0,0 +1,19 @@ +# Function: setHeaderMiddleware() + +> **setHeaderMiddleware**(`key`, `value`): `Middleware` + +Defined in: [src/middleware.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/middleware.ts#L9) + +## Parameters + +### key + +`string` + +### value + +`string` + +## Returns + +`Middleware` diff --git a/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderOptions.md b/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderOptions.md new file mode 100644 index 00000000000..622dbccbf2c --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderOptions.md @@ -0,0 +1,23 @@ +# Function: setHeaderOptions() + +> **setHeaderOptions**(`key`, `value`, `opt?`): `ConfigurationOptions`\<`Middleware`\> + +Defined in: [src/middleware.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/middleware.ts#L22) + +## Parameters + +### key + +`string` + +### value + +`string` + +### opt? + +`ConfigurationOptions`\<`Middleware`\> + +## Returns + +`ConfigurationOptions`\<`Middleware`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/middleware/index.md b/website/versioned_docs/version-2.0.0/sdk/middleware/index.md new file mode 100644 index 00000000000..cffdb06008c --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/middleware/index.md @@ -0,0 +1,6 @@ +# middleware + +## Functions + +- [setHeaderMiddleware](functions/setHeaderMiddleware.md) +- [setHeaderOptions](functions/setHeaderOptions.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/object/classes/KubernetesObjectApi.md b/website/versioned_docs/version-2.0.0/sdk/object/classes/KubernetesObjectApi.md new file mode 100644 index 00000000000..77fd7fe91fe --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/object/classes/KubernetesObjectApi.md @@ -0,0 +1,466 @@ +# Class: KubernetesObjectApi + +Defined in: [src/object.ts:37](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L37) + +Dynamically construct Kubernetes API request URIs so client does not have to know what type of object it is acting +on. + +## Constructors + +### Constructor + +> **new KubernetesObjectApi**(`configuration`): `KubernetesObjectApi` + +Defined in: [src/object.ts:59](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L59) + +#### Parameters + +##### configuration + +`Configuration` + +#### Returns + +`KubernetesObjectApi` + +## Methods + +### create() + +> **create**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `options?`): `Promise`\<`T`\> + +Defined in: [src/object.ts:76](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L76) + +Create any Kubernetes resource. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### spec + +`T` + +Kubernetes resource spec. + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### dryRun? + +`string` + +When present, indicates that modifications should not be persisted. An invalid or unrecognized + dryRun directive will result in an error response and no further processing of the request. Valid values + are: - All: all dry run stages will be processed + +##### fieldManager? + +`string` + +fieldManager is a name associated with the actor or entity that is making these changes. The + value must be less than or 128 characters long, and only contain printable characters, as defined by + https://golang.org/pkg/unicode/#IsPrint. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`T`\> + +Promise containing the request response and [[KubernetesObject]]. + +*** + +### delete() + +> **delete**(`spec`, `pretty?`, `dryRun?`, `gracePeriodSeconds?`, `orphanDependents?`, `propagationPolicy?`, `body?`, `options?`): `Promise`\<`V1Status`\> + +Defined in: [src/object.ts:145](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L145) + +Delete any Kubernetes resource. + +#### Parameters + +##### spec + +[`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +Kubernetes resource spec + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### dryRun? + +`string` + +When present, indicates that modifications should not be persisted. An invalid or unrecognized + dryRun directive will result in an error response and no further processing of the request. Valid values + are: - All: all dry run stages will be processed + +##### gracePeriodSeconds? + +`number` + +The duration in seconds before the object should be deleted. Value must be non-negative + integer. The value zero indicates delete immediately. If this value is nil, the default grace period for + the specified type will be used. Defaults to a per object value if not specified. zero means delete + immediately. + +##### orphanDependents? + +`boolean` + +Deprecated: please use the PropagationPolicy, this field will be deprecated in + 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be + added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be + set, but not both. + +##### propagationPolicy? + +`string` + +Whether and how garbage collection will be performed. Either this field or + OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in + the metadata.finalizers and the resource-specific default policy. Acceptable values are: + \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete + the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents + in the foreground. + +##### body? + +`V1DeleteOptions` + +See [[V1DeleteOptions]]. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`V1Status`\> + +Promise containing the request response and a Kubernetes [[V1Status]]. + +*** + +### list() + +> **list**\<`T`\>(`apiVersion`, `kind`, `namespace?`, `pretty?`, `exact?`, `exportt?`, `fieldSelector?`, `labelSelector?`, `limit?`, `continueToken?`, `options?`): `Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> + +Defined in: [src/object.ts:349](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L349) + +List any Kubernetes resources. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### apiVersion + +`string` + +api group and version of the form / + +##### kind + +`string` + +Kubernetes resource kind + +##### namespace? + +`string` + +list resources in this namespace + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### exact? + +`boolean` + +Should the export be exact. Exact export maintains cluster-specific fields like + \'Namespace\'. Deprecated. Planned for removal in 1.18. + +##### exportt? + +`boolean` + +Should this value be exported. Export strips fields that a user can not + specify. Deprecated. Planned for removal in 1.18. + +##### fieldSelector? + +`string` + +A selector to restrict the list of returned objects by their fields. Defaults to everything. + +##### labelSelector? + +`string` + +A selector to restrict the list of returned objects by their labels. Defaults to everything. + +##### limit? + +`number` + +Number of returned resources. + +##### continueToken? + +`string` + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> + +Promise containing the request response and [[KubernetesListObject]]. + +*** + +### patch() + +> **patch**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `force?`, `patchStrategy?`, `options?`): `Promise`\<`T`\> + +Defined in: [src/object.ts:230](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L230) + +Patch any Kubernetes resource. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### spec + +`T` + +Kubernetes resource spec + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### dryRun? + +`string` + +When present, indicates that modifications should not be persisted. An invalid or unrecognized + dryRun directive will result in an error response and no further processing of the request. Valid values + are: - All: all dry run stages will be processed + +##### fieldManager? + +`string` + +fieldManager is a name associated with the actor or entity that is making these changes. The + value must be less than or 128 characters long, and only contain printable characters, as defined by + https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests + (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, + StrategicMergePatch). + +##### force? + +`boolean` + +Force is going to \"force\" Apply requests. It means user will re-acquire conflicting + fields owned by other people. Force flag must be unset for non-apply patch requests. + +##### patchStrategy? + +[`PatchStrategy`](../../patch/type-aliases/PatchStrategy.md) = `PatchStrategy.StrategicMergePatch` + +Content-Type header used to control how the patch will be performed. See + See https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ + for details. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`T`\> + +Promise containing the request response and [[KubernetesObject]]. + +*** + +### read() + +> **read**\<`T`\>(`spec`, `pretty?`, `exact?`, `exportt?`, `options?`): `Promise`\<`T`\> + +Defined in: [src/object.ts:292](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L292) + +Read any Kubernetes resource. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### spec + +`KubernetesObjectHeader`\<`T`\> + +Kubernetes resource spec + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### exact? + +`boolean` + +Should the export be exact. Exact export maintains cluster-specific fields like + \'Namespace\'. Deprecated. Planned for removal in 1.18. + +##### exportt? + +`boolean` + +Should this value be exported. Export strips fields that a user can not + specify. Deprecated. Planned for removal in 1.18. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`T`\> + +Promise containing the request response and [[KubernetesObject]]. + +*** + +### replace() + +> **replace**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `options?`): `Promise`\<`T`\> + +Defined in: [src/object.ts:436](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L436) + +Replace any Kubernetes resource. + +#### Type Parameters + +##### T + +`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) + +#### Parameters + +##### spec + +`T` + +Kubernetes resource spec + +##### pretty? + +`string` + +If \'true\', then the output is pretty printed. + +##### dryRun? + +`string` + +When present, indicates that modifications should not be persisted. An invalid or unrecognized + dryRun directive will result in an error response and no further processing of the request. Valid values + are: - All: all dry run stages will be processed + +##### fieldManager? + +`string` + +fieldManager is a name associated with the actor or entity that is making these changes. The + value must be less than or 128 characters long, and only contain printable characters, as defined by + https://golang.org/pkg/unicode/#IsPrint. + +##### options? + +`Configuration`\<`Middleware`\> + +Optional headers to use in the request. + +#### Returns + +`Promise`\<`T`\> + +Promise containing the request response and [[KubernetesObject]]. + +*** + +### makeApiClient() + +> `static` **makeApiClient**(`kc`): `KubernetesObjectApi` + +Defined in: [src/object.ts:46](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L46) + +Create a KubernetesObjectApi object from the provided KubeConfig. This method should be used rather than +[[KubeConfig.makeApiClient]] so we can properly determine the default namespace if one is provided by the current +context. + +#### Parameters + +##### kc + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +Valid Kubernetes config + +#### Returns + +`KubernetesObjectApi` + +Properly instantiated [[KubernetesObjectApi]] object diff --git a/website/versioned_docs/version-2.0.0/sdk/object/index.md b/website/versioned_docs/version-2.0.0/sdk/object/index.md new file mode 100644 index 00000000000..82633830a1e --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/object/index.md @@ -0,0 +1,5 @@ +# object + +## Classes + +- [KubernetesObjectApi](classes/KubernetesObjectApi.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/patch/index.md b/website/versioned_docs/version-2.0.0/sdk/patch/index.md new file mode 100644 index 00000000000..33a10aae72b --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/patch/index.md @@ -0,0 +1,9 @@ +# patch + +## Type Aliases + +- [PatchStrategy](type-aliases/PatchStrategy.md) + +## Variables + +- [PatchStrategy](variables/PatchStrategy.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/patch/type-aliases/PatchStrategy.md b/website/versioned_docs/version-2.0.0/sdk/patch/type-aliases/PatchStrategy.md new file mode 100644 index 00000000000..e318f53ca68 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/patch/type-aliases/PatchStrategy.md @@ -0,0 +1,12 @@ +# Type Alias: PatchStrategy + +> **PatchStrategy** = *typeof* [`PatchStrategy`](../variables/PatchStrategy.md)\[keyof *typeof* [`PatchStrategy`](../variables/PatchStrategy.md)\] + +Defined in: [src/patch.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/patch.ts#L9) + +Valid Content-Type header values for patch operations. See +https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +for details. + +Additionally for Server-Side Apply https://kubernetes.io/docs/reference/using-api/server-side-apply/ +and https://kubernetes.io/docs/reference/using-api/server-side-apply/#api-implementation diff --git a/website/versioned_docs/version-2.0.0/sdk/patch/variables/PatchStrategy.md b/website/versioned_docs/version-2.0.0/sdk/patch/variables/PatchStrategy.md new file mode 100644 index 00000000000..778971a3b63 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/patch/variables/PatchStrategy.md @@ -0,0 +1,38 @@ +# Variable: PatchStrategy + +> `const` **PatchStrategy**: `object` + +Defined in: [src/patch.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/patch.ts#L9) + +Valid Content-Type header values for patch operations. See +https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +for details. + +Additionally for Server-Side Apply https://kubernetes.io/docs/reference/using-api/server-side-apply/ +and https://kubernetes.io/docs/reference/using-api/server-side-apply/#api-implementation + +## Type Declaration + +### JsonPatch + +> `readonly` **JsonPatch**: `"application/json-patch+json"` = `'application/json-patch+json'` + +Diff-like JSON format. + +### MergePatch + +> `readonly` **MergePatch**: `"application/merge-patch+json"` = `'application/merge-patch+json'` + +Simple merge. + +### ServerSideApply + +> `readonly` **ServerSideApply**: `"application/apply-patch+yaml"` = `'application/apply-patch+yaml'` + +Server-Side Apply + +### StrategicMergePatch + +> `readonly` **StrategicMergePatch**: `"application/strategic-merge-patch+json"` = `'application/strategic-merge-patch+json'` + +Merge with different strategies depending on field metadata. diff --git a/website/versioned_docs/version-2.0.0/sdk/portforward/classes/PortForward.md b/website/versioned_docs/version-2.0.0/sdk/portforward/classes/PortForward.md new file mode 100644 index 00000000000..8d85ee5a8d1 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/portforward/classes/PortForward.md @@ -0,0 +1,195 @@ +# Class: PortForward + +Defined in: [src/portforward.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L9) + +## Constructors + +### Constructor + +> **new PortForward**(`config`, `disconnectOnErr?`, `handler?`): `PortForward` + +Defined in: [src/portforward.ts:15](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L15) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +##### disconnectOnErr? + +`boolean` + +##### handler? + +`WebSocketInterface` + +#### Returns + +`PortForward` + +## Methods + +### portForward() + +> **portForward**(`namespace`, `podName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> + +Defined in: [src/portforward.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L22) + +#### Parameters + +##### namespace + +`string` + +##### podName + +`string` + +##### targetPorts + +`number`[] + +##### output + +`Writable` + +##### err + +`Writable` \| `null` + +##### input + +`Readable` + +##### retryCount? + +`number` = `0` + +#### Returns + +`Promise`\<`any`\> + +*** + +### portForwardDeployment() + +> **portForwardDeployment**(`namespace`, `deploymentName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> + +Defined in: [src/portforward.ts:123](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L123) + +Port forward to a deployment by resolving to the first ready pod selected by the deployment's selector. + +#### Parameters + +##### namespace + +`string` + +The namespace of the deployment + +##### deploymentName + +`string` + +The name of the deployment + +##### targetPorts + +`number`[] + +The target ports to forward to + +##### output + +`Writable` + +The writable stream for output + +##### err + +`Writable` \| `null` + +The writable stream for error output (can be null) + +##### input + +`Readable` + +The readable stream for input + +##### retryCount? + +`number` = `0` + +The number of times to retry the connection + +#### Returns + +`Promise`\<`any`\> + +#### Throws + +Will throw an error if the deployment is not found or has no ready pods + +*** + +### portForwardService() + +> **portForwardService**(`namespace`, `serviceName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> + +Defined in: [src/portforward.ts:89](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L89) + +Port forward to a service by resolving to the first ready pod selected by the service's selector. + +#### Parameters + +##### namespace + +`string` + +The namespace of the service + +##### serviceName + +`string` + +The name of the service + +##### targetPorts + +`number`[] + +The target ports to forward to + +##### output + +`Writable` + +The writable stream for output + +##### err + +`Writable` \| `null` + +The writable stream for error output (can be null) + +##### input + +`Readable` + +The readable stream for input + +##### retryCount? + +`number` = `0` + +The number of times to retry the connection + +#### Returns + +`Promise`\<`any`\> + +#### Throws + +Will throw an error if the service is not found or has no ready pods diff --git a/website/versioned_docs/version-2.0.0/sdk/portforward/index.md b/website/versioned_docs/version-2.0.0/sdk/portforward/index.md new file mode 100644 index 00000000000..5330431e384 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/portforward/index.md @@ -0,0 +1,5 @@ +# portforward + +## Classes + +- [PortForward](classes/PortForward.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/ContainerStatus.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/ContainerStatus.md new file mode 100644 index 00000000000..e3845761a7e --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/top/classes/ContainerStatus.md @@ -0,0 +1,53 @@ +# Class: ContainerStatus + +Defined in: [src/top.ts:49](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L49) + +## Constructors + +### Constructor + +> **new ContainerStatus**(`Container`, `CPUUsage`, `MemoryUsage`): `ContainerStatus` + +Defined in: [src/top.ts:54](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L54) + +#### Parameters + +##### Container + +`string` + +##### CPUUsage + +[`CurrentResourceUsage`](CurrentResourceUsage.md) + +##### MemoryUsage + +[`CurrentResourceUsage`](CurrentResourceUsage.md) + +#### Returns + +`ContainerStatus` + +## Properties + +### Container + +> `readonly` **Container**: `string` + +Defined in: [src/top.ts:50](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L50) + +*** + +### CPUUsage + +> `readonly` **CPUUsage**: [`CurrentResourceUsage`](CurrentResourceUsage.md) + +Defined in: [src/top.ts:51](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L51) + +*** + +### MemoryUsage + +> `readonly` **MemoryUsage**: [`CurrentResourceUsage`](CurrentResourceUsage.md) + +Defined in: [src/top.ts:52](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L52) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/CurrentResourceUsage.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/CurrentResourceUsage.md new file mode 100644 index 00000000000..f358f096dff --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/top/classes/CurrentResourceUsage.md @@ -0,0 +1,53 @@ +# Class: CurrentResourceUsage + +Defined in: [src/top.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L25) + +## Constructors + +### Constructor + +> **new CurrentResourceUsage**(`CurrentUsage`, `RequestTotal`, `LimitTotal`): `CurrentResourceUsage` + +Defined in: [src/top.ts:30](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L30) + +#### Parameters + +##### CurrentUsage + +`number` \| `bigint` + +##### RequestTotal + +`number` \| `bigint` + +##### LimitTotal + +`number` \| `bigint` + +#### Returns + +`CurrentResourceUsage` + +## Properties + +### CurrentUsage + +> `readonly` **CurrentUsage**: `number` \| `bigint` + +Defined in: [src/top.ts:26](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L26) + +*** + +### LimitTotal + +> `readonly` **LimitTotal**: `number` \| `bigint` + +Defined in: [src/top.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L28) + +*** + +### RequestTotal + +> `readonly` **RequestTotal**: `number` \| `bigint` + +Defined in: [src/top.ts:27](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L27) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/NodeStatus.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/NodeStatus.md new file mode 100644 index 00000000000..43537ba4498 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/top/classes/NodeStatus.md @@ -0,0 +1,53 @@ +# Class: NodeStatus + +Defined in: [src/top.ts:37](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L37) + +## Constructors + +### Constructor + +> **new NodeStatus**(`Node`, `CPU`, `Memory`): `NodeStatus` + +Defined in: [src/top.ts:42](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L42) + +#### Parameters + +##### Node + +`V1Node` + +##### CPU + +[`ResourceUsage`](ResourceUsage.md) + +##### Memory + +[`ResourceUsage`](ResourceUsage.md) + +#### Returns + +`NodeStatus` + +## Properties + +### CPU + +> `readonly` **CPU**: [`ResourceUsage`](ResourceUsage.md) + +Defined in: [src/top.ts:39](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L39) + +*** + +### Memory + +> `readonly` **Memory**: [`ResourceUsage`](ResourceUsage.md) + +Defined in: [src/top.ts:40](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L40) + +*** + +### Node + +> `readonly` **Node**: `V1Node` + +Defined in: [src/top.ts:38](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L38) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/PodStatus.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/PodStatus.md new file mode 100644 index 00000000000..57f06c2f10e --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/top/classes/PodStatus.md @@ -0,0 +1,65 @@ +# Class: PodStatus + +Defined in: [src/top.ts:61](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L61) + +## Constructors + +### Constructor + +> **new PodStatus**(`Pod`, `CPU`, `Memory`, `Containers`): `PodStatus` + +Defined in: [src/top.ts:67](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L67) + +#### Parameters + +##### Pod + +`V1Pod` + +##### CPU + +[`CurrentResourceUsage`](CurrentResourceUsage.md) + +##### Memory + +[`CurrentResourceUsage`](CurrentResourceUsage.md) + +##### Containers + +[`ContainerStatus`](ContainerStatus.md)[] + +#### Returns + +`PodStatus` + +## Properties + +### Containers + +> `readonly` **Containers**: [`ContainerStatus`](ContainerStatus.md)[] + +Defined in: [src/top.ts:65](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L65) + +*** + +### CPU + +> `readonly` **CPU**: [`CurrentResourceUsage`](CurrentResourceUsage.md) + +Defined in: [src/top.ts:63](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L63) + +*** + +### Memory + +> `readonly` **Memory**: [`CurrentResourceUsage`](CurrentResourceUsage.md) + +Defined in: [src/top.ts:64](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L64) + +*** + +### Pod + +> `readonly` **Pod**: `V1Pod` + +Defined in: [src/top.ts:62](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L62) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/ResourceUsage.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/ResourceUsage.md new file mode 100644 index 00000000000..e568265c380 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/top/classes/ResourceUsage.md @@ -0,0 +1,53 @@ +# Class: ResourceUsage + +Defined in: [src/top.ts:13](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L13) + +## Constructors + +### Constructor + +> **new ResourceUsage**(`Capacity`, `RequestTotal`, `LimitTotal`): `ResourceUsage` + +Defined in: [src/top.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L18) + +#### Parameters + +##### Capacity + +`number` \| `bigint` + +##### RequestTotal + +`number` \| `bigint` + +##### LimitTotal + +`number` \| `bigint` + +#### Returns + +`ResourceUsage` + +## Properties + +### Capacity + +> `readonly` **Capacity**: `number` \| `bigint` + +Defined in: [src/top.ts:14](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L14) + +*** + +### LimitTotal + +> `readonly` **LimitTotal**: `number` \| `bigint` + +Defined in: [src/top.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L16) + +*** + +### RequestTotal + +> `readonly` **RequestTotal**: `number` \| `bigint` + +Defined in: [src/top.ts:15](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L15) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/functions/topNodes.md b/website/versioned_docs/version-2.0.0/sdk/top/functions/topNodes.md new file mode 100644 index 00000000000..9a178e21f85 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/top/functions/topNodes.md @@ -0,0 +1,15 @@ +# Function: topNodes() + +> **topNodes**(`api`): `Promise`\<[`NodeStatus`](../classes/NodeStatus.md)[]\> + +Defined in: [src/top.ts:80](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L80) + +## Parameters + +### api + +`ObjectCoreV1Api` + +## Returns + +`Promise`\<[`NodeStatus`](../classes/NodeStatus.md)[]\> diff --git a/website/versioned_docs/version-2.0.0/sdk/top/functions/topPods.md b/website/versioned_docs/version-2.0.0/sdk/top/functions/topPods.md new file mode 100644 index 00000000000..786e2c2d443 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/top/functions/topPods.md @@ -0,0 +1,23 @@ +# Function: topPods() + +> **topPods**(`api`, `metrics`, `namespace?`): `Promise`\<[`PodStatus`](../classes/PodStatus.md)[]\> + +Defined in: [src/top.ts:111](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L111) + +## Parameters + +### api + +`ObjectCoreV1Api` + +### metrics + +[`Metrics`](../../metrics/classes/Metrics.md) + +### namespace? + +`string` + +## Returns + +`Promise`\<[`PodStatus`](../classes/PodStatus.md)[]\> diff --git a/website/versioned_docs/version-2.0.0/sdk/top/index.md b/website/versioned_docs/version-2.0.0/sdk/top/index.md new file mode 100644 index 00000000000..dda791b768b --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/top/index.md @@ -0,0 +1,14 @@ +# top + +## Classes + +- [ContainerStatus](classes/ContainerStatus.md) +- [CurrentResourceUsage](classes/CurrentResourceUsage.md) +- [NodeStatus](classes/NodeStatus.md) +- [PodStatus](classes/PodStatus.md) +- [ResourceUsage](classes/ResourceUsage.md) + +## Functions + +- [topNodes](functions/topNodes.md) +- [topPods](functions/topPods.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/typedoc-sidebar.cjs b/website/versioned_docs/version-2.0.0/sdk/typedoc-sidebar.cjs new file mode 100644 index 00000000000..575b5c88e97 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ +const typedocSidebar = {items:[{type:"category",label:"attach",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/attach/classes/Attach",label:"Attach"}]}],link:{type:"doc",id:"sdk/attach/index"}},{type:"category",label:"cache",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/cache/classes/ListWatch",label:"ListWatch"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/cache/interfaces/ObjectCache",label:"ObjectCache"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/cache/type-aliases/CacheMap",label:"CacheMap"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/cache/functions/addOrUpdateObject",label:"addOrUpdateObject"},{type:"doc",id:"sdk/cache/functions/cacheMapFromList",label:"cacheMapFromList"},{type:"doc",id:"sdk/cache/functions/deleteItems",label:"deleteItems"},{type:"doc",id:"sdk/cache/functions/deleteObject",label:"deleteObject"}]}],link:{type:"doc",id:"sdk/cache/index"}},{type:"category",label:"config",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/config/classes/KubeConfig",label:"KubeConfig"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/config/interfaces/ApiType",label:"ApiType"},{type:"doc",id:"sdk/config/interfaces/Named",label:"Named"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/config/type-aliases/ApiConstructor",label:"ApiConstructor"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/config/functions/bufferFromFileOrString",label:"bufferFromFileOrString"},{type:"doc",id:"sdk/config/functions/findHomeDir",label:"findHomeDir"},{type:"doc",id:"sdk/config/functions/findObject",label:"findObject"},{type:"doc",id:"sdk/config/functions/makeAbsolutePath",label:"makeAbsolutePath"}]}],link:{type:"doc",id:"sdk/config/index"}},{type:"category",label:"config_types",items:[{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/config_types/interfaces/Cluster",label:"Cluster"},{type:"doc",id:"sdk/config_types/interfaces/ConfigOptions",label:"ConfigOptions"},{type:"doc",id:"sdk/config_types/interfaces/Context",label:"Context"},{type:"doc",id:"sdk/config_types/interfaces/User",label:"User"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/config_types/type-aliases/ActionOnInvalid",label:"ActionOnInvalid"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/config_types/variables/ActionOnInvalid",label:"ActionOnInvalid"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/config_types/functions/exportCluster",label:"exportCluster"},{type:"doc",id:"sdk/config_types/functions/exportContext",label:"exportContext"},{type:"doc",id:"sdk/config_types/functions/exportUser",label:"exportUser"},{type:"doc",id:"sdk/config_types/functions/newClusters",label:"newClusters"},{type:"doc",id:"sdk/config_types/functions/newContexts",label:"newContexts"},{type:"doc",id:"sdk/config_types/functions/newUsers",label:"newUsers"}]}],link:{type:"doc",id:"sdk/config_types/index"}},{type:"category",label:"cp",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/cp/classes/Cp",label:"Cp"}]}],link:{type:"doc",id:"sdk/cp/index"}},{type:"category",label:"exec",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/exec/classes/Exec",label:"Exec"}]}],link:{type:"doc",id:"sdk/exec/index"}},{type:"category",label:"health",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/health/classes/Health",label:"Health"}]}],link:{type:"doc",id:"sdk/health/index"}},{type:"category",label:"informer",items:[{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/informer/interfaces/Informer",label:"Informer"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/informer/type-aliases/ADD",label:"ADD"},{type:"doc",id:"sdk/informer/type-aliases/CHANGE",label:"CHANGE"},{type:"doc",id:"sdk/informer/type-aliases/CONNECT",label:"CONNECT"},{type:"doc",id:"sdk/informer/type-aliases/DELETE",label:"DELETE"},{type:"doc",id:"sdk/informer/type-aliases/ERROR",label:"ERROR"},{type:"doc",id:"sdk/informer/type-aliases/ErrorCallback",label:"ErrorCallback"},{type:"doc",id:"sdk/informer/type-aliases/ListCallback",label:"ListCallback"},{type:"doc",id:"sdk/informer/type-aliases/ListPromise",label:"ListPromise"},{type:"doc",id:"sdk/informer/type-aliases/ObjectCallback",label:"ObjectCallback"},{type:"doc",id:"sdk/informer/type-aliases/UPDATE",label:"UPDATE"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/informer/variables/ADD",label:"ADD"},{type:"doc",id:"sdk/informer/variables/CHANGE",label:"CHANGE"},{type:"doc",id:"sdk/informer/variables/CONNECT",label:"CONNECT"},{type:"doc",id:"sdk/informer/variables/DELETE",label:"DELETE"},{type:"doc",id:"sdk/informer/variables/ERROR",label:"ERROR"},{type:"doc",id:"sdk/informer/variables/UPDATE",label:"UPDATE"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/informer/functions/makeInformer",label:"makeInformer"}]}],link:{type:"doc",id:"sdk/informer/index"}},{type:"category",label:"log",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/log/classes/Log",label:"Log"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/log/interfaces/LogOptions",label:"LogOptions"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/log/functions/AddOptionsToSearchParams",label:"AddOptionsToSearchParams"}]}],link:{type:"doc",id:"sdk/log/index"}},{type:"category",label:"metrics",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/metrics/classes/Metrics",label:"Metrics"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/metrics/interfaces/ContainerMetric",label:"ContainerMetric"},{type:"doc",id:"sdk/metrics/interfaces/NodeMetric",label:"NodeMetric"},{type:"doc",id:"sdk/metrics/interfaces/NodeMetricsList",label:"NodeMetricsList"},{type:"doc",id:"sdk/metrics/interfaces/PodMetric",label:"PodMetric"},{type:"doc",id:"sdk/metrics/interfaces/PodMetricsList",label:"PodMetricsList"},{type:"doc",id:"sdk/metrics/interfaces/Usage",label:"Usage"}]}],link:{type:"doc",id:"sdk/metrics/index"}},{type:"category",label:"middleware",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/middleware/functions/setHeaderMiddleware",label:"setHeaderMiddleware"},{type:"doc",id:"sdk/middleware/functions/setHeaderOptions",label:"setHeaderOptions"}]}],link:{type:"doc",id:"sdk/middleware/index"}},{type:"category",label:"object",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/object/classes/KubernetesObjectApi",label:"KubernetesObjectApi"}]}],link:{type:"doc",id:"sdk/object/index"}},{type:"category",label:"patch",items:[{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/patch/type-aliases/PatchStrategy",label:"PatchStrategy"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/patch/variables/PatchStrategy",label:"PatchStrategy"}]}],link:{type:"doc",id:"sdk/patch/index"}},{type:"category",label:"portforward",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/portforward/classes/PortForward",label:"PortForward"}]}],link:{type:"doc",id:"sdk/portforward/index"}},{type:"category",label:"top",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/top/classes/ContainerStatus",label:"ContainerStatus"},{type:"doc",id:"sdk/top/classes/CurrentResourceUsage",label:"CurrentResourceUsage"},{type:"doc",id:"sdk/top/classes/NodeStatus",label:"NodeStatus"},{type:"doc",id:"sdk/top/classes/PodStatus",label:"PodStatus"},{type:"doc",id:"sdk/top/classes/ResourceUsage",label:"ResourceUsage"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/top/functions/topNodes",label:"topNodes"},{type:"doc",id:"sdk/top/functions/topPods",label:"topPods"}]}],link:{type:"doc",id:"sdk/top/index"}},{type:"category",label:"types",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/types/classes/V1MicroTime",label:"V1MicroTime"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/types/interfaces/KubernetesListObject",label:"KubernetesListObject"},{type:"doc",id:"sdk/types/interfaces/KubernetesObject",label:"KubernetesObject"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/types/type-aliases/IntOrString",label:"IntOrString"}]}],link:{type:"doc",id:"sdk/types/index"}},{type:"category",label:"watch",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/watch/classes/Watch",label:"Watch"}]}],link:{type:"doc",id:"sdk/watch/index"}},{type:"category",label:"yaml",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/yaml/functions/dumpYaml",label:"dumpYaml"},{type:"doc",id:"sdk/yaml/functions/loadAllYaml",label:"loadAllYaml"},{type:"doc",id:"sdk/yaml/functions/loadYaml",label:"loadYaml"}]}],link:{type:"doc",id:"sdk/yaml/index"}}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/website/versioned_docs/version-2.0.0/sdk/types/classes/V1MicroTime.md b/website/versioned_docs/version-2.0.0/sdk/types/classes/V1MicroTime.md new file mode 100644 index 00000000000..c60344e02ec --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/types/classes/V1MicroTime.md @@ -0,0 +1,141 @@ +# Class: V1MicroTime + +Defined in: [src/types.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L18) + +## Extends + +- `Date` + +## Constructors + +### Constructor + +> **new V1MicroTime**(): `V1MicroTime` + +Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:926 + +#### Returns + +`V1MicroTime` + +#### Inherited from + +`Date.constructor` + +### Constructor + +> **new V1MicroTime**(`value`): `V1MicroTime` + +Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:927 + +#### Parameters + +##### value + +`string` \| `number` + +#### Returns + +`V1MicroTime` + +#### Inherited from + +`Date.constructor` + +### Constructor + +> **new V1MicroTime**(`year`, `monthIndex`, `date?`, `hours?`, `minutes?`, `seconds?`, `ms?`): `V1MicroTime` + +Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:938 + +Creates a new Date. + +#### Parameters + +##### year + +`number` + +The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year. + +##### monthIndex + +`number` + +The month as a number between 0 and 11 (January to December). + +##### date? + +`number` + +The date as a number between 1 and 31. + +##### hours? + +`number` + +Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour. + +##### minutes? + +`number` + +Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes. + +##### seconds? + +`number` + +Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds. + +##### ms? + +`number` + +A number from 0 to 999 that specifies the milliseconds. + +#### Returns + +`V1MicroTime` + +#### Inherited from + +`Date.constructor` + +### Constructor + +> **new V1MicroTime**(`value`): `V1MicroTime` + +Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:926 + +#### Parameters + +##### value + +`string` \| `number` \| `Date` + +#### Returns + +`V1MicroTime` + +#### Inherited from + +`Date.constructor` + +## Methods + +### toISOString() + +> **toISOString**(): `string` + +Defined in: [src/types.ts:19](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L19) + +Returns a date as a string value in ISO format. + +#### Returns + +`string` + +#### Overrides + +`Date.toISOString` diff --git a/website/versioned_docs/version-2.0.0/sdk/types/index.md b/website/versioned_docs/version-2.0.0/sdk/types/index.md new file mode 100644 index 00000000000..cdc701721b3 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/types/index.md @@ -0,0 +1,14 @@ +# types + +## Classes + +- [V1MicroTime](classes/V1MicroTime.md) + +## Interfaces + +- [KubernetesListObject](interfaces/KubernetesListObject.md) +- [KubernetesObject](interfaces/KubernetesObject.md) + +## Type Aliases + +- [IntOrString](type-aliases/IntOrString.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesListObject.md b/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesListObject.md new file mode 100644 index 00000000000..64d51265ac2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesListObject.md @@ -0,0 +1,41 @@ +# Interface: KubernetesListObject\ + +Defined in: [src/types.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L9) + +## Type Parameters + +### T + +`T` *extends* [`KubernetesObject`](KubernetesObject.md) + +## Properties + +### apiVersion? + +> `optional` **apiVersion?**: `string` + +Defined in: [src/types.ts:10](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L10) + +*** + +### items + +> **items**: `T`[] + +Defined in: [src/types.ts:13](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L13) + +*** + +### kind? + +> `optional` **kind?**: `string` + +Defined in: [src/types.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L11) + +*** + +### metadata? + +> `optional` **metadata?**: `V1ListMeta` + +Defined in: [src/types.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L12) diff --git a/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesObject.md b/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesObject.md new file mode 100644 index 00000000000..85f27be16f9 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesObject.md @@ -0,0 +1,27 @@ +# Interface: KubernetesObject + +Defined in: [src/types.ts:3](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L3) + +## Properties + +### apiVersion? + +> `optional` **apiVersion?**: `string` + +Defined in: [src/types.ts:4](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L4) + +*** + +### kind? + +> `optional` **kind?**: `string` + +Defined in: [src/types.ts:5](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L5) + +*** + +### metadata? + +> `optional` **metadata?**: `V1ObjectMeta` + +Defined in: [src/types.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L6) diff --git a/website/versioned_docs/version-2.0.0/sdk/types/type-aliases/IntOrString.md b/website/versioned_docs/version-2.0.0/sdk/types/type-aliases/IntOrString.md new file mode 100644 index 00000000000..4ef656418c2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/types/type-aliases/IntOrString.md @@ -0,0 +1,5 @@ +# Type Alias: IntOrString + +> **IntOrString** = `number` \| `string` + +Defined in: [src/types.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L16) diff --git a/website/versioned_docs/version-2.0.0/sdk/watch/classes/Watch.md b/website/versioned_docs/version-2.0.0/sdk/watch/classes/Watch.md new file mode 100644 index 00000000000..233007bafe2 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/watch/classes/Watch.md @@ -0,0 +1,67 @@ +# Class: Watch + +Defined in: [src/watch.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L6) + +## Constructors + +### Constructor + +> **new Watch**(`config`): `Watch` + +Defined in: [src/watch.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L11) + +#### Parameters + +##### config + +[`KubeConfig`](../../config/classes/KubeConfig.md) + +#### Returns + +`Watch` + +## Properties + +### config + +> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) + +Defined in: [src/watch.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L8) + +*** + +### SERVER\_SIDE\_CLOSE + +> `static` **SERVER\_SIDE\_CLOSE**: `object` + +Defined in: [src/watch.ts:7](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L7) + +## Methods + +### watch() + +> **watch**(`path`, `queryParams`, `callback`, `done`): `Promise`\<`AbortController`\> + +Defined in: [src/watch.ts:21](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L21) + +#### Parameters + +##### path + +`string` + +##### queryParams + +`Record`\<`string`, `string` \| `number` \| `boolean` \| `undefined`\> + +##### callback + +(`phase`, `apiObj`, `watchObj?`) => `void` + +##### done + +(`err`) => `void` + +#### Returns + +`Promise`\<`AbortController`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/watch/index.md b/website/versioned_docs/version-2.0.0/sdk/watch/index.md new file mode 100644 index 00000000000..6c5ddb17669 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/watch/index.md @@ -0,0 +1,5 @@ +# watch + +## Classes + +- [Watch](classes/Watch.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/dumpYaml.md b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/dumpYaml.md new file mode 100644 index 00000000000..ee7fe699f12 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/dumpYaml.md @@ -0,0 +1,27 @@ +# Function: dumpYaml() + +> **dumpYaml**(`object`, `opts?`): `string` + +Defined in: [src/yaml.ts:43](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/yaml.ts#L43) + +Dump a Kubernetes object to YAML. + +## Parameters + +### object + +`any` + +The Kubernetes object to dump. + +### opts? + +`any` + +Optional YAML dump options. + +## Returns + +`string` + +The YAML string representation of the serialized Kubernetes object. diff --git a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadAllYaml.md b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadAllYaml.md new file mode 100644 index 00000000000..cbd1f2cd088 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadAllYaml.md @@ -0,0 +1,27 @@ +# Function: loadAllYaml() + +> **loadAllYaml**(`data`, `opts?`): `any`[] + +Defined in: [src/yaml.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/yaml.ts#L28) + +Load all Kubernetes objects from YAML. + +## Parameters + +### data + +`string` + +The YAML string to load. + +### opts? + +`any` + +Optional YAML load options. + +## Returns + +`any`[] + +An array of deserialized Kubernetes objects. diff --git a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadYaml.md b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadYaml.md new file mode 100644 index 00000000000..a8c76574ee9 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadYaml.md @@ -0,0 +1,33 @@ +# Function: loadYaml() + +> **loadYaml**\<`T`\>(`data`, `opts?`): `T` + +Defined in: [src/yaml.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/yaml.ts#L12) + +Load a Kubernetes object from YAML. + +## Type Parameters + +### T + +`T` + +## Parameters + +### data + +`string` + +The YAML string to load. + +### opts? + +`any` + +Optional YAML load options. + +## Returns + +`T` + +The deserialized Kubernetes object. diff --git a/website/versioned_docs/version-2.0.0/sdk/yaml/index.md b/website/versioned_docs/version-2.0.0/sdk/yaml/index.md new file mode 100644 index 00000000000..016ec239289 --- /dev/null +++ b/website/versioned_docs/version-2.0.0/sdk/yaml/index.md @@ -0,0 +1,7 @@ +# yaml + +## Functions + +- [dumpYaml](functions/dumpYaml.md) +- [loadAllYaml](functions/loadAllYaml.md) +- [loadYaml](functions/loadYaml.md) diff --git a/website/versioned_sidebars/version-2.0.0-sidebars.json b/website/versioned_sidebars/version-2.0.0-sidebars.json new file mode 100644 index 00000000000..28114f3a515 --- /dev/null +++ b/website/versioned_sidebars/version-2.0.0-sidebars.json @@ -0,0 +1,150 @@ +{ + "docs": [ + { + "type": "category", + "label": "Getting Started", + "collapsed": false, + "items": [ + "intro" + ] + }, + { + "type": "category", + "label": "SDK Reference", + "collapsed": false, + "items": [ + { + "type": "category", + "label": "Configuration", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "sdk/config" + }, + { + "type": "autogenerated", + "dirName": "sdk/config_types" + } + ] + }, + { + "type": "category", + "label": "Watching & Caching", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "sdk/watch" + }, + { + "type": "autogenerated", + "dirName": "sdk/informer" + }, + { + "type": "autogenerated", + "dirName": "sdk/cache" + } + ] + }, + { + "type": "category", + "label": "Pod Operations", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "sdk/exec" + }, + { + "type": "autogenerated", + "dirName": "sdk/attach" + }, + { + "type": "autogenerated", + "dirName": "sdk/portforward" + }, + { + "type": "autogenerated", + "dirName": "sdk/cp" + }, + { + "type": "autogenerated", + "dirName": "sdk/log" + } + ] + }, + { + "type": "category", + "label": "Cluster Operations", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "sdk/metrics" + }, + { + "type": "autogenerated", + "dirName": "sdk/top" + } + ] + }, + { + "type": "category", + "label": "Utilities", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "sdk/object" + }, + { + "type": "autogenerated", + "dirName": "sdk/patch" + }, + { + "type": "autogenerated", + "dirName": "sdk/health" + }, + { + "type": "autogenerated", + "dirName": "sdk/middleware" + }, + { + "type": "autogenerated", + "dirName": "sdk/types" + }, + { + "type": "autogenerated", + "dirName": "sdk/yaml" + } + ] + } + ] + }, + { + "type": "category", + "label": "Kubernetes API Reference", + "collapsed": false, + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "api-reference" + } + ] + } + ] +} diff --git a/website/versions.json b/website/versions.json new file mode 100644 index 00000000000..3aea0349a87 --- /dev/null +++ b/website/versions.json @@ -0,0 +1,3 @@ +[ + "2.0.0" +] From 861fdb15bb7ba919b0ba8c906152ce9440e9d3c5 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Thu, 26 Mar 2026 17:41:31 -0400 Subject: [PATCH 05/11] docs: add CI workflow, update README, add version snapshot to release Task 12: deploy-docs-v2.yml for Docusaurus gh-pages deploy Task 13: root .gitignore + README updated for Docusaurus docs Task 14: release.yml version snapshot step for auto-versioning --- .github/workflows/deploy-docs-v2.yml | 31 ++++++++++++++++++++++++++++ .github/workflows/release.yml | 14 +++++++++++++ .gitignore | 7 ++++++- README.md | 20 +++++++++++++----- 4 files changed, 66 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/deploy-docs-v2.yml diff --git a/.github/workflows/deploy-docs-v2.yml b/.github/workflows/deploy-docs-v2.yml new file mode 100644 index 00000000000..5491dd5f079 --- /dev/null +++ b/.github/workflows/deploy-docs-v2.yml @@ -0,0 +1,31 @@ +name: Build and Deploy Docs v2 +on: + push: + branches: + - main + pull_request: + branches: + - main +jobs: + build-and-deploy-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v6.0.1 + - name: Setup Node.js + uses: actions/setup-node@v6 + with: + node-version: '20' + - name: Install root dependencies + run: npm ci + - name: Install website dependencies + run: npm ci + working-directory: website + - name: Build website + run: npm run build + working-directory: website + - name: Deploy to gh-pages + uses: JamesIves/github-pages-deploy-action@v4 + with: + branch: gh-pages + folder: website/build diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index fe86b736fa8..78b5a73ef51 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -69,3 +69,17 @@ jobs: env: RELEASE_VERSION: ${{ github.event.inputs.releaseVersion }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Install website dependencies + run: cd website && npm ci + - name: Run prebuild + run: cd website && npm run prebuild + - name: Create version snapshot + run: cd website && npx docusaurus docs:version ${{ github.ref_name }} + - name: Commit versioned docs + if: ${{ github.event.inputs.dry_run != 'true' }} + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + git add website/versions.json website/versioned_docs/ website/versioned_sidebars/ + git commit -m "docs: snapshot version ${{ github.ref_name }}" || echo "No changes to commit" + git push diff --git a/.gitignore b/.gitignore index 8e3e2975ef2..eaba01c533c 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,9 @@ kubernetes-client-node-*.tgz **/*.swp .idea/ docs/* -.DS_Store \ No newline at end of file +.DS_Store + +# Docusaurus +website/.docusaurus +website/build +website/node_modules \ No newline at end of file diff --git a/README.md b/README.md index 68c529b64ba..3c80b842996 100644 --- a/README.md +++ b/README.md @@ -95,14 +95,24 @@ const k8sApi = kc.makeApiClient(k8s.CoreV1Api); ... ``` -# Additional Examples and Documentation +# Documentation -There are several more JS and TS examples in the [examples](https://github.com/kubernetes-client/javascript/tree/main/examples) directory. +📖 **[View Documentation](https://kubernetes-client.github.io/javascript/)** + +Documentation is built with [Docusaurus](https://docusaurus.io/) and includes: + +- SDK Reference (KubeConfig, Watch, Informer, Exec, etc.) +- Kubernetes API Reference (all API groups) +- Version selector for historical releases +- [Kubernetes API Reference](https://kubernetes.io/docs/reference/) — source-of-truth for all Kubernetes client libraries -Documentation for the library is split into two resources: +To build docs locally: -1. The [Kubernetes API Reference](https://kubernetes.io/docs/reference/) is the source-of-truth for all Kubernetes client libraries, including this one. We suggest starting here! -2. The Typedoc autogenerated docs can be viewed [online](https://kubernetes-client.github.io/javascript) and can also be built locally (see below) +```bash +cd website && npm install && npm run build +``` + +There are several more JS and TS examples in the [examples](https://github.com/kubernetes-client/javascript/tree/main/examples) directory. # Compatibility From 168c81405b3c910de82713c88cf5ebbd50663fa6 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Thu, 26 Mar 2026 19:19:19 -0400 Subject: [PATCH 06/11] fix(docs): address verification review issues --- .github/workflows/deploy-docs-v2.yml | 3 + .github/workflows/release.yml | 4 +- website/README.md | 41 ----- website/package.json | 3 +- website/scripts/extract-api-groups.mjs | 14 -- .../src/components/HomepageFeatures/index.tsx | 71 -------- .../HomepageFeatures/styles.module.css | 11 -- website/src/pages/markdown-page.md | 7 - website/static/img/docusaurus.png | Bin 5142 -> 0 bytes .../static/img/undraw_docusaurus_mountain.svg | 171 ------------------ .../static/img/undraw_docusaurus_react.svg | 170 ----------------- website/static/img/undraw_docusaurus_tree.svg | 40 ---- 12 files changed, 7 insertions(+), 528 deletions(-) delete mode 100644 website/README.md delete mode 100644 website/src/components/HomepageFeatures/index.tsx delete mode 100644 website/src/components/HomepageFeatures/styles.module.css delete mode 100644 website/src/pages/markdown-page.md delete mode 100644 website/static/img/docusaurus.png delete mode 100644 website/static/img/undraw_docusaurus_mountain.svg delete mode 100644 website/static/img/undraw_docusaurus_react.svg delete mode 100644 website/static/img/undraw_docusaurus_tree.svg diff --git a/.github/workflows/deploy-docs-v2.yml b/.github/workflows/deploy-docs-v2.yml index 5491dd5f079..89338a95fb0 100644 --- a/.github/workflows/deploy-docs-v2.yml +++ b/.github/workflows/deploy-docs-v2.yml @@ -6,6 +6,8 @@ on: pull_request: branches: - main +permissions: + contents: write jobs: build-and-deploy-docs: runs-on: ubuntu-latest @@ -25,6 +27,7 @@ jobs: run: npm run build working-directory: website - name: Deploy to gh-pages + if: github.event_name == 'push' uses: JamesIves/github-pages-deploy-action@v4 with: branch: gh-pages diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 78b5a73ef51..7e4a2e3f353 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -73,8 +73,8 @@ jobs: run: cd website && npm ci - name: Run prebuild run: cd website && npm run prebuild - - name: Create version snapshot - run: cd website && npx docusaurus docs:version ${{ github.ref_name }} + - name: Create version snapshot + run: cd website && npx docusaurus docs:version ${{ github.event.inputs.releaseVersion }} - name: Commit versioned docs if: ${{ github.event.inputs.dry_run != 'true' }} run: | diff --git a/website/README.md b/website/README.md deleted file mode 100644 index b28211a9bbd..00000000000 --- a/website/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Website - -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. - -## Installation - -```bash -yarn -``` - -## Local Development - -```bash -yarn start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -## Build - -```bash -yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -Using SSH: - -```bash -USE_SSH=true yarn deploy -``` - -Not using SSH: - -```bash -GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/website/package.json b/website/package.json index 0c4a17de864..0cd555dea60 100644 --- a/website/package.json +++ b/website/package.json @@ -14,7 +14,8 @@ "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", - "typecheck": "tsc" + "typecheck": "tsc", + "test": "node --experimental-vm-modules node_modules/.bin/jest scripts/__tests__/transform.test.mjs" }, "dependencies": { "@docusaurus/core": "3.9.2", diff --git a/website/scripts/extract-api-groups.mjs b/website/scripts/extract-api-groups.mjs index 3e0bbc48dc2..1b1b2cda59e 100755 --- a/website/scripts/extract-api-groups.mjs +++ b/website/scripts/extract-api-groups.mjs @@ -109,20 +109,6 @@ for (const docFile of docFiles) { continue; } - if ( - className === 'CustomObjectsApi' || - className === 'WatchApi' || - className === 'VersionApi' || - className === 'LogsApi' - ) { - apiGroupMap[className] = { - group: className.replace('Api', ''), - version: 'v1', - category: 'Other', - }; - continue; - } - // Parse standard class names like "AppsV1Api", "AdmissionregistrationV1alpha1Api" // Pattern: {GroupName}{VersionName}Api let group = null; diff --git a/website/src/components/HomepageFeatures/index.tsx b/website/src/components/HomepageFeatures/index.tsx deleted file mode 100644 index c2551fb9b80..00000000000 --- a/website/src/components/HomepageFeatures/index.tsx +++ /dev/null @@ -1,71 +0,0 @@ -import type {ReactNode} from 'react'; -import clsx from 'clsx'; -import Heading from '@theme/Heading'; -import styles from './styles.module.css'; - -type FeatureItem = { - title: string; - Svg: React.ComponentType>; - description: ReactNode; -}; - -const FeatureList: FeatureItem[] = [ - { - title: 'Easy to Use', - Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, - description: ( - <> - Docusaurus was designed from the ground up to be easily installed and - used to get your website up and running quickly. - - ), - }, - { - title: 'Focus on What Matters', - Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, - description: ( - <> - Docusaurus lets you focus on your docs, and we'll do the chores. Go - ahead and move your docs into the docs directory. - - ), - }, - { - title: 'Powered by React', - Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, - description: ( - <> - Extend or customize your website layout by reusing React. Docusaurus can - be extended while reusing the same header and footer. - - ), - }, -]; - -function Feature({title, Svg, description}: FeatureItem) { - return ( -
-
- -
-
- {title} -

{description}

-
-
- ); -} - -export default function HomepageFeatures(): ReactNode { - return ( -
-
-
- {FeatureList.map((props, idx) => ( - - ))} -
-
-
- ); -} diff --git a/website/src/components/HomepageFeatures/styles.module.css b/website/src/components/HomepageFeatures/styles.module.css deleted file mode 100644 index b248eb2e5de..00000000000 --- a/website/src/components/HomepageFeatures/styles.module.css +++ /dev/null @@ -1,11 +0,0 @@ -.features { - display: flex; - align-items: center; - padding: 2rem 0; - width: 100%; -} - -.featureSvg { - height: 200px; - width: 200px; -} diff --git a/website/src/pages/markdown-page.md b/website/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b6685..00000000000 --- a/website/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/website/static/img/docusaurus.png b/website/static/img/docusaurus.png deleted file mode 100644 index f458149e3c8f53335f28fbc162ae67f55575c881..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5142 zcma)=cTf{R(}xj7f`AaDml%oxrAm_`5IRVc-jPtHML-0kDIiip57LWD@4bW~(nB|) z34|^sbOZqj<;8ct`Tl-)=Jw`pZtiw=e$UR_Mn2b8rM$y@hlq%XQe90+?|Mf68-Ux_ zzTBiDn~3P%oVt>{f$z+YC7A)8ak`PktoIXDkpXod+*gQW4fxTWh!EyR9`L|fi4YlH z{IyM;2-~t3s~J-KF~r-Z)FWquQCfG*TQy6w*9#k2zUWV-+tCNvjrtl9(o}V>-)N!) ziZgEgV>EG+b(j@ex!dx5@@nGZim*UfFe<+e;(xL|j-Pxg(PCsTL~f^br)4{n5?OU@ z*pjt{4tG{qBcDSa3;yKlopENd6Yth=+h9)*lkjQ0NwgOOP+5Xf?SEh$x6@l@ZoHoYGc5~d2>pO43s3R|*yZw9yX^kEyUV2Zw1%J4o`X!BX>CwJ zI8rh1-NLH^x1LnaPGki_t#4PEz$ad+hO^$MZ2 ziwt&AR}7_yq-9Pfn}k3`k~dKCbOsHjvWjnLsP1{)rzE8ERxayy?~{Qz zHneZ2gWT3P|H)fmp>vA78a{0&2kk3H1j|n59y{z@$?jmk9yptqCO%* zD2!3GHNEgPX=&Ibw?oU1>RSxw3;hhbOV77-BiL%qQb1(4J|k=Y{dani#g>=Mr?Uyd z)1v~ZXO_LT-*RcG%;i|Wy)MvnBrshlQoPxoO*82pKnFSGNKWrb?$S$4x+24tUdpb= zr$c3K25wQNUku5VG@A=`$K7%?N*K+NUJ(%%)m0Vhwis*iokN#atyu(BbK?+J+=H z!kaHkFGk+qz`uVgAc600d#i}WSs|mtlkuwPvFp) z1{Z%nt|NwDEKj1(dhQ}GRvIj4W?ipD76jZI!PGjd&~AXwLK*98QMwN&+dQN1ML(6< z@+{1`=aIc z9Buqm97vy3RML|NsM@A>Nw2=sY_3Ckk|s;tdn>rf-@Ke1m!%F(9(3>V%L?w#O&>yn z(*VIm;%bgezYB;xRq4?rY})aTRm>+RL&*%2-B%m; zLtxLTBS=G!bC$q;FQ|K3{nrj1fUp`43Qs&V!b%rTVfxlDGsIt3}n4p;1%Llj5ePpI^R} zl$Jhx@E}aetLO!;q+JH@hmelqg-f}8U=XnQ+~$9RHGUDOoR*fR{io*)KtYig%OR|08ygwX%UqtW81b@z0*`csGluzh_lBP=ls#1bwW4^BTl)hd|IIfa zhg|*M%$yt@AP{JD8y!7kCtTmu{`YWw7T1}Xlr;YJTU1mOdaAMD172T8Mw#UaJa1>V zQ6CD0wy9NEwUsor-+y)yc|Vv|H^WENyoa^fWWX zwJz@xTHtfdhF5>*T70(VFGX#8DU<^Z4Gez7vn&4E<1=rdNb_pj@0?Qz?}k;I6qz@| zYdWfcA4tmI@bL5JcXuoOWp?ROVe*&o-T!><4Ie9@ypDc!^X&41u(dFc$K$;Tv$c*o zT1#8mGWI8xj|Hq+)#h5JToW#jXJ73cpG-UE^tsRf4gKw>&%Z9A>q8eFGC zG@Iv(?40^HFuC_-%@u`HLx@*ReU5KC9NZ)bkS|ZWVy|_{BOnlK)(Gc+eYiFpMX>!# zG08xle)tntYZ9b!J8|4H&jaV3oO(-iFqB=d}hGKk0 z%j)johTZhTBE|B-xdinS&8MD=XE2ktMUX8z#eaqyU?jL~PXEKv!^) zeJ~h#R{@O93#A4KC`8@k8N$T3H8EV^E2 z+FWxb6opZnX-av5ojt@`l3TvSZtYLQqjps{v;ig5fDo^}{VP=L0|uiRB@4ww$Eh!CC;75L%7|4}xN+E)3K&^qwJizphcnn=#f<&Np$`Ny%S)1*YJ`#@b_n4q zi%3iZw8(I)Dzp0yY}&?<-`CzYM5Rp+@AZg?cn00DGhf=4|dBF8BO~2`M_My>pGtJwNt4OuQm+dkEVP4 z_f*)ZaG6@t4-!}fViGNd%E|2%ylnzr#x@C!CrZSitkHQ}?_;BKAIk|uW4Zv?_npjk z*f)ztC$Cj6O<_{K=dPwO)Z{I=o9z*lp?~wmeTTP^DMP*=<-CS z2FjPA5KC!wh2A)UzD-^v95}^^tT<4DG17#wa^C^Q`@f@=jLL_c3y8@>vXDJd6~KP( zurtqU1^(rnc=f5s($#IxlkpnU=ATr0jW`)TBlF5$sEwHLR_5VPTGiO?rSW9*ND`bYN*OX&?=>!@61{Z4)@E;VI9 zvz%NmR*tl>p-`xSPx$}4YcdRc{_9k)>4Jh&*TSISYu+Y!so!0JaFENVY3l1n*Fe3_ zRyPJ(CaQ-cNP^!3u-X6j&W5|vC1KU!-*8qCcT_rQN^&yqJ{C(T*`(!A=))=n%*-zp_ewRvYQoJBS7b~ zQlpFPqZXKCXUY3RT{%UFB`I-nJcW0M>1^*+v)AxD13~5#kfSkpWys^#*hu)tcd|VW zEbVTi`dbaM&U485c)8QG#2I#E#h)4Dz8zy8CLaq^W#kXdo0LH=ALhK{m_8N@Bj=Um zTmQOO*ID(;Xm}0kk`5nCInvbW9rs0pEw>zlO`ZzIGkB7e1Afs9<0Z(uS2g*BUMhp> z?XdMh^k}k<72>}p`Gxal3y7-QX&L{&Gf6-TKsE35Pv%1 z;bJcxPO+A9rPGsUs=rX(9^vydg2q`rU~otOJ37zb{Z{|)bAS!v3PQ5?l$+LkpGNJq zzXDLcS$vMy|9sIidXq$NE6A-^v@)Gs_x_3wYxF%y*_e{B6FvN-enGst&nq0z8Hl0< z*p6ZXC*su`M{y|Fv(Vih_F|83=)A6ay-v_&ph1Fqqcro{oeu99Y0*FVvRFmbFa@gs zJ*g%Gik{Sb+_zNNf?Qy7PTf@S*dTGt#O%a9WN1KVNj`q$1Qoiwd|y&_v?}bR#>fdP zSlMy2#KzRq4%?ywXh1w;U&=gKH%L~*m-l%D4Cl?*riF2~r*}ic9_{JYMAwcczTE`!Z z^KfriRf|_YcQ4b8NKi?9N7<4;PvvQQ}*4YxemKK3U-7i}ap8{T7=7`e>PN7BG-Ej;Uti2$o=4T#VPb zm1kISgGzj*b?Q^MSiLxj26ypcLY#RmTPp+1>9zDth7O?w9)onA%xqpXoKA-`Jh8cZ zGE(7763S3qHTKNOtXAUA$H;uhGv75UuBkyyD;eZxzIn6;Ye7JpRQ{-6>)ioiXj4Mr zUzfB1KxvI{ZsNj&UA`+|)~n}96q%_xKV~rs?k=#*r*7%Xs^Hm*0~x>VhuOJh<2tcb zKbO9e-w3zbekha5!N@JhQm7;_X+J!|P?WhssrMv5fnQh$v*986uWGGtS}^szWaJ*W z6fLVt?OpPMD+-_(3x8Ra^sX~PT1t5S6bfk@Jb~f-V)jHRul#Hqu;0(+ER7Z(Z4MTR z+iG>bu+BW2SNh|RAGR2-mN5D1sTcb-rLTha*@1@>P~u;|#2N{^AC1hxMQ|(sp3gTa zDO-E8Yn@S7u=a?iZ!&&Qf2KKKk7IT`HjO`U*j1~Df9Uxz$~@otSCK;)lbLSmBuIj% zPl&YEoRwsk$8~Az>>djrdtp`PX z`Pu#IITS7lw07vx>YE<4pQ!&Z^7L?{Uox`CJnGjYLh1XN^tt#zY*0}tA*a=V)rf=&-kLgD|;t1D|ORVY}8 F{0H{b<4^zq diff --git a/website/static/img/undraw_docusaurus_mountain.svg b/website/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index af961c49a88..00000000000 --- a/website/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,171 +0,0 @@ - - Easy to Use - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website/static/img/undraw_docusaurus_react.svg b/website/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index 94b5cf08f88..00000000000 --- a/website/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,170 +0,0 @@ - - Powered by React - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website/static/img/undraw_docusaurus_tree.svg b/website/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index d9161d33920..00000000000 --- a/website/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1,40 +0,0 @@ - - Focus on What Matters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - From 7630d5b7e7f58cc594a7bcd621a3da8c88067a7f Mon Sep 17 00:00:00 2001 From: David Gamero Date: Wed, 6 May 2026 20:46:15 -0400 Subject: [PATCH 07/11] docs: add examples section, remove versioned docs, refine build scripts - Add 5 example pages (basic-operations, pod-operations, watching-and-caching, kubectl-equivalents, advanced) pulling from real source files - Remove v2.0.0 versioned snapshot in favor of unversioned 'next' docs - Add remark plugin for example links, SDK flatten plugin, model generation - Update transform and flatten scripts with improved API doc generation - Clean up config: add remarkPlugins, format detection, custom 404 - Update CI workflow and README with docs instructions --- .github/workflows/deploy-docs-v2.yml | 2 + README.md | 24 +- website/.gitignore | 1 + website/docs/examples/_category_.json | 4 + website/docs/examples/advanced.mdx | 59 + website/docs/examples/basic-operations.mdx | 45 + website/docs/examples/kubectl-equivalents.mdx | 69 + website/docs/examples/pod-operations.mdx | 49 + .../docs/examples/watching-and-caching.mdx | 36 + website/docs/intro.md | 3 +- website/docusaurus.config.ts | 22 +- website/package-lock.json | 38519 +++++++-------- website/package.json | 107 +- website/scripts/enrich-sdk-docs.mjs | 75 + website/scripts/flatten-sdk-docs.mjs | 304 + website/scripts/generate-models.mjs | 302 + website/scripts/plugin-flatten-sdk.mjs | 34 + website/scripts/remark-example-links.mjs | 303 + website/scripts/transform-gen-docs.mjs | 1073 +- website/sidebars.ts | 31 +- website/src/pages/404.tsx | 50 + website/src/pages/index.module.css | 23 - website/src/pages/index.tsx | 81 - .../cluster/AdmissionregistrationApi.md | 62 - .../cluster/AdmissionregistrationV1Api.md | 3767 -- .../AdmissionregistrationV1alpha1Api.md | 1750 - .../AdmissionregistrationV1beta1Api.md | 1750 - .../api-reference/cluster/ApiextensionsApi.md | 62 - .../cluster/ApiextensionsV1Api.md | 1484 - .../cluster/ApiregistrationApi.md | 62 - .../cluster/ApiregistrationV1Api.md | 1031 - .../api-reference/cluster/SchedulingApi.md | 62 - .../api-reference/cluster/SchedulingV1Api.md | 719 - .../cluster/SchedulingV1alpha1Api.md | 853 - .../api-reference/cluster/_category_.json | 4 - .../configuration-storage/CoordinationApi.md | 62 - .../CoordinationV1Api.md | 835 - .../CoordinationV1alpha2Api.md | 833 - .../CoordinationV1beta1Api.md | 833 - .../configuration-storage/PolicyApi.md | 62 - .../configuration-storage/PolicyV1Api.md | 1191 - .../configuration-storage/StorageApi.md | 62 - .../configuration-storage/StorageV1Api.md | 5308 --- .../StorageV1beta1Api.md | 719 - .../StoragemigrationApi.md | 62 - .../StoragemigrationV1beta1Api.md | 1016 - .../configuration-storage/_category_.json | 4 - .../api-reference/core-resources/CoreApi.md | 62 - .../api-reference/core-resources/CoreV1Api.md | 39221 ---------------- .../api-reference/core-resources/EventsApi.md | 62 - .../core-resources/EventsV1Api.md | 889 - .../api-reference/core-resources/NodeApi.md | 62 - .../api-reference/core-resources/NodeV1Api.md | 751 - .../core-resources/_category_.json | 4 - .../api-reference/networking/DiscoveryApi.md | 62 - .../networking/DiscoveryV1Api.md | 913 - .../api-reference/networking/NetworkingApi.md | 62 - .../networking/NetworkingV1Api.md | 4552 -- .../networking/NetworkingV1beta1Api.md | 1675 - .../api-reference/networking/_category_.json | 4 - .../api-reference/other/ApisApi.md | 62 - .../api-reference/other/AutoscalingApi.md | 62 - .../api-reference/other/AutoscalingV1Api.md | 1125 - .../api-reference/other/AutoscalingV2Api.md | 1833 - .../api-reference/other/CustomObjectsApi.md | 2234 - .../other/FlowcontrolApiserverApi.md | 62 - .../other/FlowcontrolApiserverV1Api.md | 2147 - .../other/InternalApiserverApi.md | 62 - .../other/InternalApiserverV1alpha1Api.md | 1037 - .../api-reference/other/LogsApi.md | 111 - .../api-reference/other/OpenidApi.md | 62 - .../api-reference/other/ResourceApi.md | 62 - .../api-reference/other/ResourceV1Api.md | 4243 -- .../other/ResourceV1alpha3Api.md | 1034 - .../api-reference/other/ResourceV1beta1Api.md | 4237 -- .../api-reference/other/ResourceV1beta2Api.md | 4243 -- .../api-reference/other/VersionApi.md | 62 - .../api-reference/other/WellKnownApi.md | 62 - .../api-reference/other/_category_.json | 4 - .../security/AuthenticationApi.md | 62 - .../security/AuthenticationV1Api.md | 329 - .../security/AuthorizationApi.md | 62 - .../security/AuthorizationV1Api.md | 709 - .../api-reference/security/CertificatesApi.md | 62 - .../security/CertificatesV1Api.md | 1331 - .../security/CertificatesV1alpha1Api.md | 719 - .../security/CertificatesV1beta1Api.md | 1824 - .../security/RbacAuthorizationApi.md | 62 - .../security/RbacAuthorizationV1Api.md | 3034 -- .../api-reference/security/_category_.json | 4 - .../api-reference/workloads/AppsApi.md | 62 - .../api-reference/workloads/AppsV1Api.md | 28122 ----------- .../api-reference/workloads/BatchApi.md | 62 - .../api-reference/workloads/BatchV1Api.md | 13489 ------ .../api-reference/workloads/_category_.json | 4 - website/versioned_docs/version-2.0.0/intro.md | 81 - .../sdk/attach/classes/Attach.md | 75 - .../version-2.0.0/sdk/attach/index.md | 5 - .../sdk/cache/classes/ListWatch.md | 248 - .../sdk/cache/functions/addOrUpdateObject.md | 33 - .../sdk/cache/functions/cacheMapFromList.md | 21 - .../sdk/cache/functions/deleteItems.md | 29 - .../sdk/cache/functions/deleteObject.md | 29 - .../version-2.0.0/sdk/cache/index.md | 20 - .../sdk/cache/interfaces/ObjectCache.md | 49 - .../sdk/cache/type-aliases/CacheMap.md | 11 - .../sdk/config/classes/KubeConfig.md | 559 - .../functions/bufferFromFileOrString.md | 19 - .../sdk/config/functions/findHomeDir.md | 15 - .../sdk/config/functions/findObject.md | 29 - .../sdk/config/functions/makeAbsolutePath.md | 19 - .../version-2.0.0/sdk/config/index.md | 21 - .../sdk/config/interfaces/ApiType.md | 3 - .../sdk/config/interfaces/Named.md | 11 - .../sdk/config/type-aliases/ApiConstructor.md | 21 - .../config_types/functions/exportCluster.md | 15 - .../config_types/functions/exportContext.md | 15 - .../sdk/config_types/functions/exportUser.md | 15 - .../sdk/config_types/functions/newClusters.md | 19 - .../sdk/config_types/functions/newContexts.md | 19 - .../sdk/config_types/functions/newUsers.md | 19 - .../version-2.0.0/sdk/config_types/index.md | 25 - .../sdk/config_types/interfaces/Cluster.md | 59 - .../config_types/interfaces/ConfigOptions.md | 11 - .../sdk/config_types/interfaces/Context.md | 35 - .../sdk/config_types/interfaces/User.md | 91 - .../type-aliases/ActionOnInvalid.md | 5 - .../config_types/variables/ActionOnInvalid.md | 15 - .../version-2.0.0/sdk/cp/classes/Cp.md | 127 - .../version-2.0.0/sdk/cp/index.md | 5 - .../version-2.0.0/sdk/exec/classes/Exec.md | 103 - .../version-2.0.0/sdk/exec/index.md | 5 - .../sdk/health/classes/Health.md | 65 - .../version-2.0.0/sdk/health/index.md | 5 - .../versioned_docs/version-2.0.0/sdk/index.md | 22 - .../sdk/informer/functions/makeInformer.md | 33 - .../version-2.0.0/sdk/informer/index.md | 31 - .../sdk/informer/interfaces/Informer.md | 121 - .../sdk/informer/type-aliases/ADD.md | 5 - .../sdk/informer/type-aliases/CHANGE.md | 5 - .../sdk/informer/type-aliases/CONNECT.md | 5 - .../sdk/informer/type-aliases/DELETE.md | 5 - .../sdk/informer/type-aliases/ERROR.md | 5 - .../informer/type-aliases/ErrorCallback.md | 15 - .../sdk/informer/type-aliases/ListCallback.md | 25 - .../sdk/informer/type-aliases/ListPromise.md | 15 - .../informer/type-aliases/ObjectCallback.md | 21 - .../sdk/informer/type-aliases/UPDATE.md | 5 - .../sdk/informer/variables/ADD.md | 5 - .../sdk/informer/variables/CHANGE.md | 5 - .../sdk/informer/variables/CONNECT.md | 5 - .../sdk/informer/variables/DELETE.md | 5 - .../sdk/informer/variables/ERROR.md | 5 - .../sdk/informer/variables/UPDATE.md | 5 - .../version-2.0.0/sdk/log/classes/Log.md | 105 - .../log/functions/AddOptionsToSearchParams.md | 19 - .../version-2.0.0/sdk/log/index.md | 13 - .../sdk/log/interfaces/LogOptions.md | 88 - .../sdk/metrics/classes/Metrics.md | 51 - .../version-2.0.0/sdk/metrics/index.md | 14 - .../sdk/metrics/interfaces/ContainerMetric.md | 19 - .../sdk/metrics/interfaces/NodeMetric.md | 47 - .../sdk/metrics/interfaces/NodeMetricsList.md | 39 - .../sdk/metrics/interfaces/PodMetric.md | 51 - .../sdk/metrics/interfaces/PodMetricsList.md | 39 - .../sdk/metrics/interfaces/Usage.md | 19 - .../functions/setHeaderMiddleware.md | 19 - .../middleware/functions/setHeaderOptions.md | 23 - .../version-2.0.0/sdk/middleware/index.md | 6 - .../sdk/object/classes/KubernetesObjectApi.md | 466 - .../version-2.0.0/sdk/object/index.md | 5 - .../version-2.0.0/sdk/patch/index.md | 9 - .../sdk/patch/type-aliases/PatchStrategy.md | 12 - .../sdk/patch/variables/PatchStrategy.md | 38 - .../sdk/portforward/classes/PortForward.md | 195 - .../version-2.0.0/sdk/portforward/index.md | 5 - .../sdk/top/classes/ContainerStatus.md | 53 - .../sdk/top/classes/CurrentResourceUsage.md | 53 - .../sdk/top/classes/NodeStatus.md | 53 - .../sdk/top/classes/PodStatus.md | 65 - .../sdk/top/classes/ResourceUsage.md | 53 - .../sdk/top/functions/topNodes.md | 15 - .../sdk/top/functions/topPods.md | 23 - .../version-2.0.0/sdk/top/index.md | 14 - .../version-2.0.0/sdk/typedoc-sidebar.cjs | 4 - .../sdk/types/classes/V1MicroTime.md | 141 - .../version-2.0.0/sdk/types/index.md | 14 - .../types/interfaces/KubernetesListObject.md | 41 - .../sdk/types/interfaces/KubernetesObject.md | 27 - .../sdk/types/type-aliases/IntOrString.md | 5 - .../version-2.0.0/sdk/watch/classes/Watch.md | 67 - .../version-2.0.0/sdk/watch/index.md | 5 - .../sdk/yaml/functions/dumpYaml.md | 27 - .../sdk/yaml/functions/loadAllYaml.md | 27 - .../sdk/yaml/functions/loadYaml.md | 33 - .../version-2.0.0/sdk/yaml/index.md | 7 - .../version-2.0.0-sidebars.json | 150 - website/versions.json | 4 +- 198 files changed, 21796 insertions(+), 167470 deletions(-) create mode 100644 website/docs/examples/_category_.json create mode 100644 website/docs/examples/advanced.mdx create mode 100644 website/docs/examples/basic-operations.mdx create mode 100644 website/docs/examples/kubectl-equivalents.mdx create mode 100644 website/docs/examples/pod-operations.mdx create mode 100644 website/docs/examples/watching-and-caching.mdx create mode 100644 website/scripts/enrich-sdk-docs.mjs create mode 100644 website/scripts/flatten-sdk-docs.mjs create mode 100644 website/scripts/generate-models.mjs create mode 100644 website/scripts/plugin-flatten-sdk.mjs create mode 100644 website/scripts/remark-example-links.mjs create mode 100644 website/src/pages/404.tsx delete mode 100644 website/src/pages/index.module.css delete mode 100644 website/src/pages/index.tsx delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1alpha1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1beta1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1alpha1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/cluster/_category_.json delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1alpha2Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1beta1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1beta1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationV1beta1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/configuration-storage/_category_.json delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/core-resources/_category_.json delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1beta1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/networking/_category_.json delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ApisApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV2Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/CustomObjectsApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverV1alpha1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/LogsApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/OpenidApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1alpha3Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta2Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/VersionApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/WellKnownApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/other/_category_.json delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/CertificatesApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1alpha1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1beta1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/security/_category_.json delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/AppsApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/AppsV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/BatchApi.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/BatchV1Api.md delete mode 100644 website/versioned_docs/version-2.0.0/api-reference/workloads/_category_.json delete mode 100644 website/versioned_docs/version-2.0.0/intro.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/attach/classes/Attach.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/attach/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/classes/ListWatch.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/functions/addOrUpdateObject.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/functions/cacheMapFromList.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteItems.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteObject.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/interfaces/ObjectCache.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cache/type-aliases/CacheMap.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/classes/KubeConfig.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/functions/bufferFromFileOrString.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/functions/findHomeDir.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/functions/findObject.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/functions/makeAbsolutePath.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/interfaces/ApiType.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/interfaces/Named.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config/type-aliases/ApiConstructor.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportCluster.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportContext.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportUser.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/newClusters.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/newContexts.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/functions/newUsers.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Cluster.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/ConfigOptions.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Context.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/User.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/type-aliases/ActionOnInvalid.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/config_types/variables/ActionOnInvalid.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cp/classes/Cp.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/cp/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/exec/classes/Exec.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/exec/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/health/classes/Health.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/health/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/functions/makeInformer.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/interfaces/Informer.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ADD.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CHANGE.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CONNECT.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/DELETE.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ERROR.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ErrorCallback.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListCallback.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListPromise.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ObjectCallback.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/UPDATE.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/ADD.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/CHANGE.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/CONNECT.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/DELETE.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/ERROR.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/informer/variables/UPDATE.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/log/classes/Log.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/log/functions/AddOptionsToSearchParams.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/log/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/log/interfaces/LogOptions.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/classes/Metrics.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/ContainerMetric.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetric.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetricsList.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetric.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetricsList.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/Usage.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderMiddleware.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderOptions.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/middleware/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/object/classes/KubernetesObjectApi.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/object/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/patch/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/patch/type-aliases/PatchStrategy.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/patch/variables/PatchStrategy.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/portforward/classes/PortForward.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/portforward/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/ContainerStatus.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/CurrentResourceUsage.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/NodeStatus.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/PodStatus.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/top/classes/ResourceUsage.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/top/functions/topNodes.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/top/functions/topPods.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/top/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/typedoc-sidebar.cjs delete mode 100644 website/versioned_docs/version-2.0.0/sdk/types/classes/V1MicroTime.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/types/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesListObject.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesObject.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/types/type-aliases/IntOrString.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/watch/classes/Watch.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/watch/index.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/yaml/functions/dumpYaml.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadAllYaml.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadYaml.md delete mode 100644 website/versioned_docs/version-2.0.0/sdk/yaml/index.md delete mode 100644 website/versioned_sidebars/version-2.0.0-sidebars.json diff --git a/.github/workflows/deploy-docs-v2.yml b/.github/workflows/deploy-docs-v2.yml index 89338a95fb0..b18c4b5d366 100644 --- a/.github/workflows/deploy-docs-v2.yml +++ b/.github/workflows/deploy-docs-v2.yml @@ -26,6 +26,8 @@ jobs: - name: Build website run: npm run build working-directory: website + - name: Validate links and anchors + run: npx @untitaker/hyperlink website/build --check-anchors --sources website/docs - name: Deploy to gh-pages if: github.event_name == 'push' uses: JamesIves/github-pages-deploy-action@v4 diff --git a/README.md b/README.md index 3c80b842996..160ef6ea0d7 100644 --- a/README.md +++ b/README.md @@ -106,10 +106,30 @@ Documentation is built with [Docusaurus](https://docusaurus.io/) and includes: - Version selector for historical releases - [Kubernetes API Reference](https://kubernetes.io/docs/reference/) — source-of-truth for all Kubernetes client libraries -To build docs locally: +## Preview docs locally ```bash -cd website && npm install && npm run build +# From the repo root — install the client library (needed by typedoc) +npm install + +# Install website dependencies and start the dev server +cd website +npm install +npm start # opens http://localhost:3000 with hot-reload +``` + +`npm start` automatically runs the `prestart` hook which generates the API +reference, SDK docs, and model pages from source before launching the dev +server. Changes to hand-written docs (e.g. `website/docs/examples/`) are +reflected instantly; changes to the generated sources require restarting the +server. + +To do a full production build (which also validates all links): + +```bash +cd website +npm run build # generates + builds static site into website/build/ +npm run serve # preview the production build at http://localhost:3000 ``` There are several more JS and TS examples in the [examples](https://github.com/kubernetes-client/javascript/tree/main/examples) directory. diff --git a/website/.gitignore b/website/.gitignore index eb2c5dbb547..8cff0dec78e 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -22,3 +22,4 @@ yarn-error.log* # Generated documentation (created by prebuild hooks) docs/api-reference/ docs/sdk/ +docs/models/ diff --git a/website/docs/examples/_category_.json b/website/docs/examples/_category_.json new file mode 100644 index 00000000000..05c8a4e606e --- /dev/null +++ b/website/docs/examples/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Examples", + "position": 2 +} diff --git a/website/docs/examples/advanced.mdx b/website/docs/examples/advanced.mdx new file mode 100644 index 00000000000..c83c47d19c5 --- /dev/null +++ b/website/docs/examples/advanced.mdx @@ -0,0 +1,59 @@ +--- +sidebar_position: 4 +--- + +import CodeBlock from '@theme/CodeBlock'; + +# Advanced + +Patching, applying manifests, scaling deployments, YAML handling, raw API access, and resource metrics. + +:::info Prerequisites +Install the client: `npm install @kubernetes/client-node`. These examples require a valid kubeconfig (default: `~/.kube/config`) or in-cluster service account. Run with Node.js 18+. +::: + +## Patch Resources + +import PatchExample from '!!raw-loader!../../../examples/typescript/patch/patch-example.ts'; + +{PatchExample} +## Apply a Manifest + +import ApplyExample from '!!raw-loader!../../../examples/typescript/apply/apply-example.ts'; + +{ApplyExample} +## Apply from File + +import ApplyFromFile from '!!raw-loader!../../../examples/typescript/apply/apply-from-file-example.ts'; + +{ApplyFromFile} +## Scale a Deployment + +import ScaleDeployment from '!!raw-loader!../../../examples/scale-deployment.js'; + +{ScaleDeployment} +## Load and Apply YAML + +import YamlExample from '!!raw-loader!../../../examples/yaml-example.js'; + +{YamlExample} +## Create an Ingress + +import IngressExample from '!!raw-loader!../../../examples/ingress.js'; + +{IngressExample} +## Raw API Request + +import RawExample from '!!raw-loader!../../../examples/raw-example.js'; + +{RawExample} +## Top Nodes + +import TopNodes from '!!raw-loader!../../../examples/top.js'; + +{TopNodes} +## Top Pods + +import TopPods from '!!raw-loader!../../../examples/top_pods.js'; + +{TopPods} diff --git a/website/docs/examples/basic-operations.mdx b/website/docs/examples/basic-operations.mdx new file mode 100644 index 00000000000..66c690d2b6b --- /dev/null +++ b/website/docs/examples/basic-operations.mdx @@ -0,0 +1,45 @@ +--- +sidebar_position: 1 +--- + +import CodeBlock from '@theme/CodeBlock'; + +# Basic Operations + +Common patterns for listing, creating, and managing Kubernetes resources. + +:::info Prerequisites +Install the client: `npm install @kubernetes/client-node`. These examples require a valid kubeconfig (default: `~/.kube/config`) or in-cluster service account. Run with Node.js 18+. +::: + +## List Pods + +import ListPods from '!!raw-loader!../../../examples/example.js'; + +{ListPods} + +## Create a Namespace + +import CreateNamespace from '!!raw-loader!../../../examples/namespace.js'; + +{CreateNamespace} + +## In-Cluster Configuration + +When running inside a Kubernetes cluster (e.g. in a Pod), use `loadFromCluster()` to authenticate via the service account. + +import InCluster from '!!raw-loader!../../../examples/in-cluster.js'; + +{InCluster} + +## Create a Job from a CronJob (In-Cluster) + +import JobFromCron from '!!raw-loader!../../../examples/in-cluster-create-job-from-cronjob.js'; + +{JobFromCron} + +## TypeScript — Basic Example + +import TSExample from '!!raw-loader!../../../examples/typescript/simple/example.ts'; + +{TSExample} diff --git a/website/docs/examples/kubectl-equivalents.mdx b/website/docs/examples/kubectl-equivalents.mdx new file mode 100644 index 00000000000..dfaf8d728a1 --- /dev/null +++ b/website/docs/examples/kubectl-equivalents.mdx @@ -0,0 +1,69 @@ +--- +sidebar_position: 5 +--- + +import CodeBlock from '@theme/CodeBlock'; + +# kubectl Equivalents + +If you're familiar with `kubectl`, these examples show how to do the same things programmatically. + +:::info Prerequisites +Install the client: `npm install @kubernetes/client-node`. These examples require a valid kubeconfig (default: `~/.kube/config`) or in-cluster service account. Run with Node.js 18+. +::: + +## kubectl get pods + +import GetPods from '!!raw-loader!../../../examples/kubectl/equivalents/get.js'; + +{GetPods} +## kubectl create + +import Create from '!!raw-loader!../../../examples/kubectl/equivalents/create.js'; + +{Create} +## kubectl apply + +import Apply from '!!raw-loader!../../../examples/kubectl/equivalents/apply.js'; + +{Apply} +## kubectl delete + +import Delete from '!!raw-loader!../../../examples/kubectl/equivalents/delete.js'; + +{Delete} +## kubectl create namespace + +import NsCreate from '!!raw-loader!../../../examples/kubectl/equivalents/namespace-create.js'; + +{NsCreate} +## kubectl create namespace (from YAML) + +import NsCreateYaml from '!!raw-loader!../../../examples/kubectl/equivalents/namespace-create-yaml.js'; + +{NsCreateYaml} +## kubectl get namespaces + +import NsList from '!!raw-loader!../../../examples/kubectl/equivalents/namespace-list.js'; + +{NsList} +## kubectl run (create pod) + +import PodCreate from '!!raw-loader!../../../examples/kubectl/equivalents/pod-create.js'; + +{PodCreate} +## kubectl get pods --namespace + +import PodFilter from '!!raw-loader!../../../examples/kubectl/equivalents/pod-filter-by-namespace.js'; + +{PodFilter} +## kubectl create resourcequota + +import RqCreate from '!!raw-loader!../../../examples/kubectl/equivalents/resourceQuota-create.js'; + +{RqCreate} +## kubectl get resourcequotas + +import RqList from '!!raw-loader!../../../examples/kubectl/equivalents/resourceQuota-list.js'; + +{RqList} diff --git a/website/docs/examples/pod-operations.mdx b/website/docs/examples/pod-operations.mdx new file mode 100644 index 00000000000..44471c73c42 --- /dev/null +++ b/website/docs/examples/pod-operations.mdx @@ -0,0 +1,49 @@ +--- +sidebar_position: 3 +--- + +import CodeBlock from '@theme/CodeBlock'; + +# Pod Operations + +Execute commands, attach to containers, forward ports, copy files, and stream logs. + +:::info Prerequisites +Install the client: `npm install @kubernetes/client-node`. These examples require a valid kubeconfig (default: `~/.kube/config`) or in-cluster service account. Run with Node.js 18+. +::: + +## Exec into a Pod + +import ExecExample from '!!raw-loader!../../../examples/typescript/exec/exec-example.ts'; + +{ExecExample} +## Attach to a Container + +import AttachExample from '!!raw-loader!../../../examples/typescript/attach/attach-example.ts'; + +{AttachExample} +## Port Forward (Pod) + +import PortForward from '!!raw-loader!../../../examples/typescript/port-forward/port-forward.ts'; + +{PortForward} +## Port Forward (Deployment) + +import PFDeployment from '!!raw-loader!../../../examples/typescript/port-forward/port-forward-deployment.ts'; + +{PFDeployment} +## Port Forward (Service) + +import PFService from '!!raw-loader!../../../examples/typescript/port-forward/port-forward-service.ts'; + +{PFService} +## Copy Files + +import CpExample from '!!raw-loader!../../../examples/typescript/cp/cp-example.ts'; + +{CpExample} +## Follow Logs + +import FollowLogs from '!!raw-loader!../../../examples/follow-logs.js'; + +{FollowLogs} diff --git a/website/docs/examples/watching-and-caching.mdx b/website/docs/examples/watching-and-caching.mdx new file mode 100644 index 00000000000..c15b7b9c2f0 --- /dev/null +++ b/website/docs/examples/watching-and-caching.mdx @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +import CodeBlock from '@theme/CodeBlock'; + +# Watching & Caching + +Watch for real-time changes to Kubernetes resources, or use informers for higher-level caching. + +:::info Prerequisites +Install the client: `npm install @kubernetes/client-node`. These examples require a valid kubeconfig (default: `~/.kube/config`) or in-cluster service account. Run with Node.js 18+. +::: + +## Watch Resources + +import WatchExample from '!!raw-loader!../../../examples/typescript/watch/watch-example.ts'; + +{WatchExample} +## Informer + +Informers provide a higher-level abstraction over watches with automatic reconnection and a local cache. + +import InformerExample from '!!raw-loader!../../../examples/typescript/informer/informer.ts'; + +{InformerExample} +## Informer with Label Selector + +import InformerLabel from '!!raw-loader!../../../examples/typescript/informer/informer-with-label-selector.ts'; + +{InformerLabel} +## Cache + +import CacheExample from '!!raw-loader!../../../examples/cache-example.js'; + +{CacheExample} diff --git a/website/docs/intro.md b/website/docs/intro.md index a8103187d34..0a5e96d2227 100644 --- a/website/docs/intro.md +++ b/website/docs/intro.md @@ -1,4 +1,5 @@ --- +slug: / sidebar_position: 1 --- @@ -76,6 +77,6 @@ Starting with release `0.13.0`, the minor version of this library tracks the min ## Links -- [SDK Reference](/docs/sdk) +- [SDK Reference](/sdk) - [Kubernetes API Reference](https://kubernetes.io/docs/reference/) - [GitHub Repository](https://github.com/kubernetes-client/javascript) diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 448a6862a4f..9d52f121f76 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -1,6 +1,8 @@ import { themes as prismThemes } from 'prism-react-renderer'; import type { Config } from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; +import remarkExampleLinks from './scripts/remark-example-links.mjs'; +import pluginFlattenSdk from './scripts/plugin-flatten-sdk.mjs'; const config: Config = { title: 'Kubernetes JavaScript Client', @@ -34,19 +36,10 @@ const config: Config = { 'classic', { docs: { + routeBasePath: '/', sidebarPath: './sidebars.ts', editUrl: 'https://github.com/kubernetes-client/javascript/tree/main/website/', - lastVersion: 'current', - versions: { - current: { - label: '2.0.0 (Next)', - banner: 'none', - }, - '2.0.0': { - label: '2.0.0', - banner: 'none', - }, - }, + remarkPlugins: [remarkExampleLinks], }, blog: false, theme: { @@ -92,6 +85,7 @@ const config: Config = { skipErrorChecking: true, }, ], + pluginFlattenSdk, ], themes: [ @@ -131,11 +125,7 @@ const config: Config = { { label: 'API Reference', position: 'left', - href: 'https://kubernetes-client.github.io/javascript/api/', - }, - { - type: 'docsVersionDropdown', - position: 'right', + to: '/api-reference/core-resources/CoreV1Api', }, { href: 'https://github.com/kubernetes-client/javascript', diff --git a/website/package-lock.json b/website/package-lock.json index beec061359d..32e5b40aa1e 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -1,19226 +1,19301 @@ { - "name": "website", - "version": "0.0.0", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "name": "website", - "version": "0.0.0", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/preset-classic": "3.9.2", - "@easyops-cn/docusaurus-search-local": "^0.55.1", - "@mdx-js/react": "^3.0.0", - "clsx": "^2.0.0", - "prism-react-renderer": "^2.3.0", - "react": "^19.0.0", - "react-dom": "^19.0.0" - }, - "devDependencies": { - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/tsconfig": "3.9.2", - "@docusaurus/types": "3.9.2", - "docusaurus-plugin-typedoc": "^1.4.2", - "typedoc": "^0.28.18", - "typedoc-plugin-markdown": "^4.11.0", - "typescript": "~5.6.2" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@algolia/abtesting": { - "version": "1.16.0", - "resolved": "https://registry.npmjs.org/@algolia/abtesting/-/abtesting-1.16.0.tgz", - "integrity": "sha512-alHFZ68/i9qLC/muEB07VQ9r7cB8AvCcGX6dVQi2PNHhc/ZQRmmFAv8KK1ay4UiseGSFr7f0nXBKsZ/jRg7e4g==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/autocomplete-core": { - "version": "1.19.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-core/-/autocomplete-core-1.19.2.tgz", - "integrity": "sha512-mKv7RyuAzXvwmq+0XRK8HqZXt9iZ5Kkm2huLjgn5JoCPtDy+oh9yxUMfDDaVCw0oyzZ1isdJBc7l9nuCyyR7Nw==", - "license": "MIT", - "dependencies": { - "@algolia/autocomplete-plugin-algolia-insights": "1.19.2", - "@algolia/autocomplete-shared": "1.19.2" - } - }, - "node_modules/@algolia/autocomplete-plugin-algolia-insights": { - "version": "1.19.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.2.tgz", - "integrity": "sha512-TjxbcC/r4vwmnZaPwrHtkXNeqvlpdyR+oR9Wi2XyfORkiGkLTVhX2j+O9SaCCINbKoDfc+c2PB8NjfOnz7+oKg==", - "license": "MIT", - "dependencies": { - "@algolia/autocomplete-shared": "1.19.2" - }, - "peerDependencies": { - "search-insights": ">= 1 < 3" - } - }, - "node_modules/@algolia/autocomplete-shared": { - "version": "1.19.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.2.tgz", - "integrity": "sha512-jEazxZTVD2nLrC+wYlVHQgpBoBB5KPStrJxLzsIFl6Kqd1AlG9sIAGl39V5tECLpIQzB3Qa2T6ZPJ1ChkwMK/w==", - "license": "MIT", - "peerDependencies": { - "@algolia/client-search": ">= 4.9.1 < 6", - "algoliasearch": ">= 4.9.1 < 6" - } - }, - "node_modules/@algolia/client-abtesting": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/client-abtesting/-/client-abtesting-5.50.0.tgz", - "integrity": "sha512-mfgUdLQNxOAvCZUGzPQxjahEWEPuQkKlV0ZtGmePOa9ZxIQZlk31vRBNbM6ScU8jTH41SCYE77G/lCifDr1SVw==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-analytics": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-5.50.0.tgz", - "integrity": "sha512-5mjokeKYyPaP3Q8IYJEnutI+O4dW/Ixxx5IgsSxT04pCfGqPXxTOH311hTQxyNpcGGEOGrMv8n8Z+UMTPamioQ==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-common": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/client-common/-/client-common-5.50.0.tgz", - "integrity": "sha512-emtOvR6dl3rX3sBJXXbofMNHU1qMQqQSWu319RMrNL5BWoBqyiq7y0Zn6cjJm7aGHV/Qbf+KCCYeWNKEMPI3BQ==", - "license": "MIT", - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-insights": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/client-insights/-/client-insights-5.50.0.tgz", - "integrity": "sha512-IerGH2/hcj/6bwkpQg/HHRqmlGN1XwygQWythAk0gZFBrghs9danJaYuSS3ShzLSVoIVth4jY5GDPX9Lbw5cgg==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-personalization": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-5.50.0.tgz", - "integrity": "sha512-3idPJeXn5L0MmgP9jk9JJqblrQ/SguN93dNK9z9gfgyupBhHnJMOEjrRYcVgTIfvG13Y04wO+Q0FxE2Ut8PVbA==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-query-suggestions": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/client-query-suggestions/-/client-query-suggestions-5.50.0.tgz", - "integrity": "sha512-q7qRoWrQK1a8m5EFQEmPlo7+pg9mVQ8X5jsChtChERre0uS2pdYEDixBBl0ydBSGkdGbLUDufcACIhH/077E4g==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-search": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.50.0.tgz", - "integrity": "sha512-Jc360x4yqb3eEg4OY4KEIdGePBxZogivKI+OGIU8aLXgAYPTECvzeOBc90312yHA1hr3AeRlAFl0rIc8lQaIrQ==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/events": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@algolia/events/-/events-4.0.1.tgz", - "integrity": "sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ==", - "license": "MIT" - }, - "node_modules/@algolia/ingestion": { - "version": "1.50.0", - "resolved": "https://registry.npmjs.org/@algolia/ingestion/-/ingestion-1.50.0.tgz", - "integrity": "sha512-OS3/Viao+NPpyBbEY3tf6hLewppG+UclD+9i0ju56mq2DrdMJFCkEky6Sk9S5VPcbLzxzg3BqBX6u9Q35w19aQ==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/monitoring": { - "version": "1.50.0", - "resolved": "https://registry.npmjs.org/@algolia/monitoring/-/monitoring-1.50.0.tgz", - "integrity": "sha512-/znwgSiGufpbJVIoDmeQaHtTq+OMdDawFRbMSJVv+12n79hW+qdQXS8/Uu3BD3yn0BzgVFJEvrsHrCsInZKdhw==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/recommend": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/recommend/-/recommend-5.50.0.tgz", - "integrity": "sha512-dHjUfu4jfjdQiKDpCpAnM7LP5yfG0oNShtfpF5rMCel6/4HIoqJ4DC4h5GKDzgrvJYtgAhblo0AYBmOM00T+lQ==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/requester-browser-xhr": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.50.0.tgz", - "integrity": "sha512-bffIbUljAWnh/Ctu5uScORajuUavqmZ0ACYd1fQQeSSYA9NNN83ynO26pSc2dZRXpSK0fkc1//qSSFXMKGu+aw==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/requester-fetch": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-fetch/-/requester-fetch-5.50.0.tgz", - "integrity": "sha512-y0EwNvPGvkM+yTAqqO6Gpt9wVGm3CLDtpLvNEiB3VGvN3WzfkjZGtLUsG/ru2kVJIIU7QcV0puuYgEpBeFxcJg==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/requester-node-http": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-5.50.0.tgz", - "integrity": "sha512-xpwefe4fCOWnZgXCbkGpqQY6jgBSCf2hmgnySbyzZIccrv3SoashHKGPE4x6vVG+gdHrGciMTAcDo9HOZwH22Q==", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@babel/code-frame": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", - "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", - "license": "MIT", - "dependencies": { - "@babel/helper-validator-identifier": "^7.28.5", - "js-tokens": "^4.0.0", - "picocolors": "^1.1.1" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/compat-data": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.0.tgz", - "integrity": "sha512-T1NCJqT/j9+cn8fvkt7jtwbLBfLC/1y1c7NtCeXFRgzGTsafi68MRv8yzkYSapBnFA6L3U2VSc02ciDzoAJhJg==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/core": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", - "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.29.0", - "@babel/generator": "^7.29.0", - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-module-transforms": "^7.28.6", - "@babel/helpers": "^7.28.6", - "@babel/parser": "^7.29.0", - "@babel/template": "^7.28.6", - "@babel/traverse": "^7.29.0", - "@babel/types": "^7.29.0", - "@jridgewell/remapping": "^2.3.5", - "convert-source-map": "^2.0.0", - "debug": "^4.1.0", - "gensync": "^1.0.0-beta.2", - "json5": "^2.2.3", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/babel" - } - }, - "node_modules/@babel/core/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/generator": { - "version": "7.29.1", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.1.tgz", - "integrity": "sha512-qsaF+9Qcm2Qv8SRIMMscAvG4O3lJ0F1GuMo5HR/Bp02LopNgnZBC/EkbevHFeGs4ls/oPz9v+Bsmzbkbe+0dUw==", - "license": "MIT", - "dependencies": { - "@babel/parser": "^7.29.0", - "@babel/types": "^7.29.0", - "@jridgewell/gen-mapping": "^0.3.12", - "@jridgewell/trace-mapping": "^0.3.28", - "jsesc": "^3.0.2" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-annotate-as-pure": { - "version": "7.27.3", - "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz", - "integrity": "sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg==", - "license": "MIT", - "dependencies": { - "@babel/types": "^7.27.3" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-compilation-targets": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz", - "integrity": "sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA==", - "license": "MIT", - "dependencies": { - "@babel/compat-data": "^7.28.6", - "@babel/helper-validator-option": "^7.27.1", - "browserslist": "^4.24.0", - "lru-cache": "^5.1.1", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-compilation-targets/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/helper-create-class-features-plugin": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.6.tgz", - "integrity": "sha512-dTOdvsjnG3xNT9Y0AUg1wAl38y+4Rl4sf9caSQZOXdNqVn+H+HbbJ4IyyHaIqNR6SW9oJpA/RuRjsjCw2IdIow==", - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-member-expression-to-functions": "^7.28.5", - "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/helper-replace-supers": "^7.28.6", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/traverse": "^7.28.6", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-create-class-features-plugin/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/helper-create-regexp-features-plugin": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.28.5.tgz", - "integrity": "sha512-N1EhvLtHzOvj7QQOUCCS3NrPJP8c5W6ZXCHDn7Yialuy1iu4r5EmIYkXlKNqT99Ciw+W0mDqWoR6HWMZlFP3hw==", - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "regexpu-core": "^6.3.1", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-create-regexp-features-plugin/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/helper-define-polyfill-provider": { - "version": "0.6.8", - "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.8.tgz", - "integrity": "sha512-47UwBLPpQi1NoWzLuHNjRoHlYXMwIJoBf7MFou6viC/sIHWYygpvr0B6IAyh5sBdA2nr2LPIRww8lfaUVQINBA==", - "license": "MIT", - "dependencies": { - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "debug": "^4.4.3", - "lodash.debounce": "^4.0.8", - "resolve": "^1.22.11" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/@babel/helper-globals": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", - "integrity": "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-member-expression-to-functions": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.28.5.tgz", - "integrity": "sha512-cwM7SBRZcPCLgl8a7cY0soT1SptSzAlMH39vwiRpOQkJlh53r5hdHwLSCZpQdVLT39sZt+CRpNwYG4Y2v77atg==", - "license": "MIT", - "dependencies": { - "@babel/traverse": "^7.28.5", - "@babel/types": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-module-imports": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz", - "integrity": "sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw==", - "license": "MIT", - "dependencies": { - "@babel/traverse": "^7.28.6", - "@babel/types": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-module-transforms": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz", - "integrity": "sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA==", - "license": "MIT", - "dependencies": { - "@babel/helper-module-imports": "^7.28.6", - "@babel/helper-validator-identifier": "^7.28.5", - "@babel/traverse": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-optimise-call-expression": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz", - "integrity": "sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw==", - "license": "MIT", - "dependencies": { - "@babel/types": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-plugin-utils": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.28.6.tgz", - "integrity": "sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-remap-async-to-generator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz", - "integrity": "sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA==", - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-wrap-function": "^7.27.1", - "@babel/traverse": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-replace-supers": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.28.6.tgz", - "integrity": "sha512-mq8e+laIk94/yFec3DxSjCRD2Z0TAjhVbEJY3UQrlwVo15Lmt7C2wAUbK4bjnTs4APkwsYLTahXRraQXhb1WCg==", - "license": "MIT", - "dependencies": { - "@babel/helper-member-expression-to-functions": "^7.28.5", - "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/traverse": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-skip-transparent-expression-wrappers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz", - "integrity": "sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg==", - "license": "MIT", - "dependencies": { - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-string-parser": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", - "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-validator-identifier": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", - "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-validator-option": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", - "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helper-wrap-function": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.28.6.tgz", - "integrity": "sha512-z+PwLziMNBeSQJonizz2AGnndLsP2DeGHIxDAn+wdHOGuo4Fo1x1HBPPXeE9TAOPHNNWQKCSlA2VZyYyyibDnQ==", - "license": "MIT", - "dependencies": { - "@babel/template": "^7.28.6", - "@babel/traverse": "^7.28.6", - "@babel/types": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/helpers": { - "version": "7.29.2", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.29.2.tgz", - "integrity": "sha512-HoGuUs4sCZNezVEKdVcwqmZN8GoHirLUcLaYVNBK2J0DadGtdcqgr3BCbvH8+XUo4NGjNl3VOtSjEKNzqfFgKw==", - "license": "MIT", - "dependencies": { - "@babel/template": "^7.28.6", - "@babel/types": "^7.29.0" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/parser": { - "version": "7.29.2", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.2.tgz", - "integrity": "sha512-4GgRzy/+fsBa72/RZVJmGKPmZu9Byn8o4MoLpmNe1m8ZfYnz5emHLQz3U4gLud6Zwl0RZIcgiLD7Uq7ySFuDLA==", - "license": "MIT", - "dependencies": { - "@babel/types": "^7.29.0" - }, - "bin": { - "parser": "bin/babel-parser.js" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.28.5.tgz", - "integrity": "sha512-87GDMS3tsmMSi/3bWOte1UblL+YUTFMV8SZPZ2eSEL17s74Cw/l63rR6NmGVKMYW2GYi85nE+/d6Hw5N0bEk2Q==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-bugfix-safari-class-field-initializer-scope": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz", - "integrity": "sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz", - "integrity": "sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz", - "integrity": "sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/plugin-transform-optional-chaining": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.13.0" - } - }, - "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.6.tgz", - "integrity": "sha512-a0aBScVTlNaiUe35UtfxAN7A/tehvvG4/ByO6+46VPKTRSlfnAFsgKy0FUh+qAkQrDTmhDkT+IBOKlOoMUxQ0g==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/traverse": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-proposal-private-property-in-object": { - "version": "7.21.0-placeholder-for-preset-env.2", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", - "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-dynamic-import": { - "version": "7.8.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz", - "integrity": "sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-import-assertions": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.28.6.tgz", - "integrity": "sha512-pSJUpFHdx9z5nqTSirOCMtYVP2wFgoWhP0p3g8ONK/4IHhLIBd0B9NYqAvIUAhq+OkhO4VM1tENCt0cjlsNShw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-import-attributes": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.28.6.tgz", - "integrity": "sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-jsx": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.28.6.tgz", - "integrity": "sha512-wgEmr06G6sIpqr8YDwA2dSRTE3bJ+V0IfpzfSY3Lfgd7YWOaAdlykvJi13ZKBt8cZHfgH1IXN+CL656W3uUa4w==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-typescript": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.28.6.tgz", - "integrity": "sha512-+nDNmQye7nlnuuHDboPbGm00Vqg3oO8niRRL27/4LYHUsHYh0zJ1xWOz0uRwNFmM1Avzk8wZbc6rdiYhomzv/A==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-unicode-sets-regex": { - "version": "7.18.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", - "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.18.6", - "@babel/helper-plugin-utils": "^7.18.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-transform-arrow-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz", - "integrity": "sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-async-generator-functions": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.29.0.tgz", - "integrity": "sha512-va0VdWro4zlBr2JsXC+ofCPB2iG12wPtVGTWFx2WLDOM3nYQZZIGP82qku2eW/JR83sD+k2k+CsNtyEbUqhU6w==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-remap-async-to-generator": "^7.27.1", - "@babel/traverse": "^7.29.0" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-async-to-generator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.28.6.tgz", - "integrity": "sha512-ilTRcmbuXjsMmcZ3HASTe4caH5Tpo93PkTxF9oG2VZsSWsahydmcEHhix9Ik122RcTnZnUzPbmux4wh1swfv7g==", - "license": "MIT", - "dependencies": { - "@babel/helper-module-imports": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-remap-async-to-generator": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-block-scoped-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz", - "integrity": "sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-block-scoping": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.6.tgz", - "integrity": "sha512-tt/7wOtBmwHPNMPu7ax4pdPz6shjFrmHDghvNC+FG9Qvj7D6mJcoRQIF5dy4njmxR941l6rgtvfSB2zX3VlUIw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-class-properties": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.28.6.tgz", - "integrity": "sha512-dY2wS3I2G7D697VHndN91TJr8/AAfXQNt5ynCTI/MpxMsSzHp+52uNivYT5wCPax3whc47DR8Ba7cmlQMg24bw==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-class-static-block": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.6.tgz", - "integrity": "sha512-rfQ++ghVwTWTqQ7w8qyDxL1XGihjBss4CmTgGRCTAC9RIbhVpyp4fOeZtta0Lbf+dTNIVJer6ych2ibHwkZqsQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.12.0" - } - }, - "node_modules/@babel/plugin-transform-classes": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.6.tgz", - "integrity": "sha512-EF5KONAqC5zAqT783iMGuM2ZtmEBy+mJMOKl2BCvPZ2lVrwvXnB6o+OBWCS+CoeCCpVRF2sA2RBKUxvT8tQT5Q==", - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-globals": "^7.28.0", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-replace-supers": "^7.28.6", - "@babel/traverse": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-computed-properties": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.28.6.tgz", - "integrity": "sha512-bcc3k0ijhHbc2lEfpFHgx7eYw9KNXqOerKWfzbxEHUGKnS3sz9C4CNL9OiFN1297bDNfUiSO7DaLzbvHQQQ1BQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/template": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-destructuring": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.5.tgz", - "integrity": "sha512-Kl9Bc6D0zTUcFUvkNuQh4eGXPKKNDOJQXVyyM4ZAQPMveniJdxi8XMJwLo+xSoW3MIq81bD33lcUe9kZpl0MCw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-dotall-regex": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.28.6.tgz", - "integrity": "sha512-SljjowuNKB7q5Oayv4FoPzeB74g3QgLt8IVJw9ADvWy3QnUb/01aw8I4AVv8wYnPvQz2GDDZ/g3GhcNyDBI4Bg==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-duplicate-keys": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz", - "integrity": "sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-duplicate-named-capturing-groups-regex": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.29.0.tgz", - "integrity": "sha512-zBPcW2lFGxdiD8PUnPwJjag2J9otbcLQzvbiOzDxpYXyCuYX9agOwMPGn1prVH0a4qzhCKu24rlH4c1f7yA8rw==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-transform-dynamic-import": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz", - "integrity": "sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-explicit-resource-management": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.6.tgz", - "integrity": "sha512-Iao5Konzx2b6g7EPqTy40UZbcdXE126tTxVFr/nAIj+WItNxjKSYTEw3RC+A2/ZetmdJsgueL1KhaMCQHkLPIg==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/plugin-transform-destructuring": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-exponentiation-operator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.28.6.tgz", - "integrity": "sha512-WitabqiGjV/vJ0aPOLSFfNY1u9U3R7W36B03r5I2KoNix+a3sOhJ3pKFB3R5It9/UiK78NiO0KE9P21cMhlPkw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-export-namespace-from": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz", - "integrity": "sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-for-of": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz", - "integrity": "sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-function-name": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz", - "integrity": "sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-compilation-targets": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-json-strings": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.28.6.tgz", - "integrity": "sha512-Nr+hEN+0geQkzhbdgQVPoqr47lZbm+5fCUmO70722xJZd0Mvb59+33QLImGj6F+DkK3xgDi1YVysP8whD6FQAw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz", - "integrity": "sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-logical-assignment-operators": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.28.6.tgz", - "integrity": "sha512-+anKKair6gpi8VsM/95kmomGNMD0eLz1NQ8+Pfw5sAwWH9fGYXT50E55ZpV0pHUHWf6IUTWPM+f/7AAff+wr9A==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-member-expression-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz", - "integrity": "sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-modules-amd": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz", - "integrity": "sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA==", - "license": "MIT", - "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-modules-commonjs": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.28.6.tgz", - "integrity": "sha512-jppVbf8IV9iWWwWTQIxJMAJCWBuuKx71475wHwYytrRGQ2CWiDvYlADQno3tcYpS/T2UUWFQp3nVtYfK/YBQrA==", - "license": "MIT", - "dependencies": { - "@babel/helper-module-transforms": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-modules-systemjs": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.29.0.tgz", - "integrity": "sha512-PrujnVFbOdUpw4UHiVwKvKRLMMic8+eC0CuNlxjsyZUiBjhFdPsewdXCkveh2KqBA9/waD0W1b4hXSOBQJezpQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-module-transforms": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-validator-identifier": "^7.28.5", - "@babel/traverse": "^7.29.0" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-modules-umd": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz", - "integrity": "sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w==", - "license": "MIT", - "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.29.0.tgz", - "integrity": "sha512-1CZQA5KNAD6ZYQLPw7oi5ewtDNxH/2vuCh+6SmvgDfhumForvs8a1o9n0UrEoBD8HU4djO2yWngTQlXl1NDVEQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-transform-new-target": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz", - "integrity": "sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.28.6.tgz", - "integrity": "sha512-3wKbRgmzYbw24mDJXT7N+ADXw8BC/imU9yo9c9X9NKaLF1fW+e5H1U5QjMUBe4Qo4Ox/o++IyUkl1sVCLgevKg==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-numeric-separator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.28.6.tgz", - "integrity": "sha512-SJR8hPynj8outz+SlStQSwvziMN4+Bq99it4tMIf5/Caq+3iOc0JtKyse8puvyXkk3eFRIA5ID/XfunGgO5i6w==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-object-rest-spread": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.6.tgz", - "integrity": "sha512-5rh+JR4JBC4pGkXLAcYdLHZjXudVxWMXbB6u6+E9lRL5TrGVbHt1TjxGbZ8CkmYw9zjkB7jutzOROArsqtncEA==", - "license": "MIT", - "dependencies": { - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/plugin-transform-destructuring": "^7.28.5", - "@babel/plugin-transform-parameters": "^7.27.7", - "@babel/traverse": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-object-super": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz", - "integrity": "sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-optional-catch-binding": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.28.6.tgz", - "integrity": "sha512-R8ja/Pyrv0OGAvAXQhSTmWyPJPml+0TMqXlO5w+AsMEiwb2fg3WkOvob7UxFSL3OIttFSGSRFKQsOhJ/X6HQdQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-optional-chaining": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.28.6.tgz", - "integrity": "sha512-A4zobikRGJTsX9uqVFdafzGkqD30t26ck2LmOzAuLL8b2x6k3TIqRiT2xVvA9fNmFeTX484VpsdgmKNA0bS23w==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-parameters": { - "version": "7.27.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz", - "integrity": "sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-private-methods": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.28.6.tgz", - "integrity": "sha512-piiuapX9CRv7+0st8lmuUlRSmX6mBcVeNQ1b4AYzJxfCMuBfB0vBXDiGSmm03pKJw1v6cZ8KSeM+oUnM6yAExg==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-private-property-in-object": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.28.6.tgz", - "integrity": "sha512-b97jvNSOb5+ehyQmBpmhOCiUC5oVK4PMnpRvO7+ymFBoqYjeDHIU9jnrNUuwHOiL9RpGDoKBpSViarV+BU+eVA==", - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-property-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz", - "integrity": "sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-constant-elements": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.27.1.tgz", - "integrity": "sha512-edoidOjl/ZxvYo4lSBOQGDSyToYVkTAwyVoa2tkuYTSmjrB1+uAedoL5iROVLXkxH+vRgA7uP4tMg2pUJpZ3Ug==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-display-name": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.28.0.tgz", - "integrity": "sha512-D6Eujc2zMxKjfa4Zxl4GHMsmhKKZ9VpcqIchJLvwTxad9zWIYulwYItBovpDOoNLISpcZSXoDJ5gaGbQUDqViA==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-jsx": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.28.6.tgz", - "integrity": "sha512-61bxqhiRfAACulXSLd/GxqmAedUSrRZIu/cbaT18T1CetkTmtDN15it7i80ru4DVqRK1WMxQhXs+Lf9kajm5Ow==", - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-module-imports": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/plugin-syntax-jsx": "^7.28.6", - "@babel/types": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-jsx-development": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-development/-/plugin-transform-react-jsx-development-7.27.1.tgz", - "integrity": "sha512-ykDdF5yI4f1WrAolLqeF3hmYU12j9ntLQl/AOG1HAS21jxyg1Q0/J/tpREuYLfatGdGmXp/3yS0ZA76kOlVq9Q==", - "license": "MIT", - "dependencies": { - "@babel/plugin-transform-react-jsx": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-pure-annotations": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.27.1.tgz", - "integrity": "sha512-JfuinvDOsD9FVMTHpzA/pBLisxpv1aSf+OIV8lgH3MuWrks19R27e6a6DipIg4aX1Zm9Wpb04p8wljfKrVSnPA==", - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-regenerator": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.29.0.tgz", - "integrity": "sha512-FijqlqMA7DmRdg/aINBSs04y8XNTYw/lr1gJ2WsmBnnaNw1iS43EPkJW+zK7z65auG3AWRFXWj+NcTQwYptUog==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-regexp-modifiers": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.28.6.tgz", - "integrity": "sha512-QGWAepm9qxpaIs7UM9FvUSnCGlb8Ua1RhyM4/veAxLwt3gMat/LSGrZixyuj4I6+Kn9iwvqCyPTtbdxanYoWYg==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-transform-reserved-words": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz", - "integrity": "sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-runtime": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.29.0.tgz", - "integrity": "sha512-jlaRT5dJtMaMCV6fAuLbsQMSwz/QkvaHOHOSXRitGGwSpR1blCY4KUKoyP2tYO8vJcqYe8cEj96cqSztv3uF9w==", - "license": "MIT", - "dependencies": { - "@babel/helper-module-imports": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "babel-plugin-polyfill-corejs2": "^0.4.14", - "babel-plugin-polyfill-corejs3": "^0.13.0", - "babel-plugin-polyfill-regenerator": "^0.6.5", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-runtime/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/plugin-transform-shorthand-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz", - "integrity": "sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-spread": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.28.6.tgz", - "integrity": "sha512-9U4QObUC0FtJl05AsUcodau/RWDytrU6uKgkxu09mLR9HLDAtUMoPuuskm5huQsoktmsYpI+bGmq+iapDcriKA==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-sticky-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz", - "integrity": "sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-template-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz", - "integrity": "sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-typeof-symbol": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz", - "integrity": "sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-typescript": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.28.6.tgz", - "integrity": "sha512-0YWL2RFxOqEm9Efk5PvreamxPME8OyY0wM5wh5lHjF+VtVhdneCWGzZeSqzOfiobVqQaNCd2z0tQvnI9DaPWPw==", - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-create-class-features-plugin": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/plugin-syntax-typescript": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-unicode-escapes": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz", - "integrity": "sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-unicode-property-regex": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.28.6.tgz", - "integrity": "sha512-4Wlbdl/sIZjzi/8St0evF0gEZrgOswVO6aOzqxh1kDZOl9WmLrHq2HtGhnOJZmHZYKP8WZ1MDLCt5DAWwRo57A==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-unicode-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz", - "integrity": "sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-unicode-sets-regex": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.28.6.tgz", - "integrity": "sha512-/wHc/paTUmsDYN7SZkpWxogTOBNnlx7nBQYfy6JJlCT7G3mVhltk3e++N7zV0XfgGsrqBxd4rJQt9H16I21Y1Q==", - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/preset-env": { - "version": "7.29.2", - "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.29.2.tgz", - "integrity": "sha512-DYD23veRYGvBFhcTY1iUvJnDNpuqNd/BzBwCvzOTKUnJjKg5kpUBh3/u9585Agdkgj+QuygG7jLfOPWMa2KVNw==", - "license": "MIT", - "dependencies": { - "@babel/compat-data": "^7.29.0", - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-plugin-utils": "^7.28.6", - "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", - "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", - "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", - "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", - "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.6", - "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", - "@babel/plugin-syntax-import-assertions": "^7.28.6", - "@babel/plugin-syntax-import-attributes": "^7.28.6", - "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", - "@babel/plugin-transform-arrow-functions": "^7.27.1", - "@babel/plugin-transform-async-generator-functions": "^7.29.0", - "@babel/plugin-transform-async-to-generator": "^7.28.6", - "@babel/plugin-transform-block-scoped-functions": "^7.27.1", - "@babel/plugin-transform-block-scoping": "^7.28.6", - "@babel/plugin-transform-class-properties": "^7.28.6", - "@babel/plugin-transform-class-static-block": "^7.28.6", - "@babel/plugin-transform-classes": "^7.28.6", - "@babel/plugin-transform-computed-properties": "^7.28.6", - "@babel/plugin-transform-destructuring": "^7.28.5", - "@babel/plugin-transform-dotall-regex": "^7.28.6", - "@babel/plugin-transform-duplicate-keys": "^7.27.1", - "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.29.0", - "@babel/plugin-transform-dynamic-import": "^7.27.1", - "@babel/plugin-transform-explicit-resource-management": "^7.28.6", - "@babel/plugin-transform-exponentiation-operator": "^7.28.6", - "@babel/plugin-transform-export-namespace-from": "^7.27.1", - "@babel/plugin-transform-for-of": "^7.27.1", - "@babel/plugin-transform-function-name": "^7.27.1", - "@babel/plugin-transform-json-strings": "^7.28.6", - "@babel/plugin-transform-literals": "^7.27.1", - "@babel/plugin-transform-logical-assignment-operators": "^7.28.6", - "@babel/plugin-transform-member-expression-literals": "^7.27.1", - "@babel/plugin-transform-modules-amd": "^7.27.1", - "@babel/plugin-transform-modules-commonjs": "^7.28.6", - "@babel/plugin-transform-modules-systemjs": "^7.29.0", - "@babel/plugin-transform-modules-umd": "^7.27.1", - "@babel/plugin-transform-named-capturing-groups-regex": "^7.29.0", - "@babel/plugin-transform-new-target": "^7.27.1", - "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6", - "@babel/plugin-transform-numeric-separator": "^7.28.6", - "@babel/plugin-transform-object-rest-spread": "^7.28.6", - "@babel/plugin-transform-object-super": "^7.27.1", - "@babel/plugin-transform-optional-catch-binding": "^7.28.6", - "@babel/plugin-transform-optional-chaining": "^7.28.6", - "@babel/plugin-transform-parameters": "^7.27.7", - "@babel/plugin-transform-private-methods": "^7.28.6", - "@babel/plugin-transform-private-property-in-object": "^7.28.6", - "@babel/plugin-transform-property-literals": "^7.27.1", - "@babel/plugin-transform-regenerator": "^7.29.0", - "@babel/plugin-transform-regexp-modifiers": "^7.28.6", - "@babel/plugin-transform-reserved-words": "^7.27.1", - "@babel/plugin-transform-shorthand-properties": "^7.27.1", - "@babel/plugin-transform-spread": "^7.28.6", - "@babel/plugin-transform-sticky-regex": "^7.27.1", - "@babel/plugin-transform-template-literals": "^7.27.1", - "@babel/plugin-transform-typeof-symbol": "^7.27.1", - "@babel/plugin-transform-unicode-escapes": "^7.27.1", - "@babel/plugin-transform-unicode-property-regex": "^7.28.6", - "@babel/plugin-transform-unicode-regex": "^7.27.1", - "@babel/plugin-transform-unicode-sets-regex": "^7.28.6", - "@babel/preset-modules": "0.1.6-no-external-plugins", - "babel-plugin-polyfill-corejs2": "^0.4.15", - "babel-plugin-polyfill-corejs3": "^0.14.0", - "babel-plugin-polyfill-regenerator": "^0.6.6", - "core-js-compat": "^3.48.0", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/preset-env/node_modules/babel-plugin-polyfill-corejs3": { - "version": "0.14.2", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.14.2.tgz", - "integrity": "sha512-coWpDLJ410R781Npmn/SIBZEsAetR4xVi0SxLMXPaMO4lSf1MwnkGYMtkFxew0Dn8B3/CpbpYxN0JCgg8mn67g==", - "license": "MIT", - "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.8", - "core-js-compat": "^3.48.0" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/@babel/preset-env/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/preset-modules": { - "version": "0.1.6-no-external-plugins", - "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", - "integrity": "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.0.0", - "@babel/types": "^7.4.4", - "esutils": "^2.0.2" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/@babel/preset-react": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.28.5.tgz", - "integrity": "sha512-Z3J8vhRq7CeLjdC58jLv4lnZ5RKFUJWqH5emvxmv9Hv3BD1T9R/Im713R4MTKwvFaV74ejZ3sM01LyEKk4ugNQ==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-transform-react-display-name": "^7.28.0", - "@babel/plugin-transform-react-jsx": "^7.27.1", - "@babel/plugin-transform-react-jsx-development": "^7.27.1", - "@babel/plugin-transform-react-pure-annotations": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/preset-typescript": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.28.5.tgz", - "integrity": "sha512-+bQy5WOI2V6LJZpPVxY+yp66XdZ2yifu0Mc1aP5CQKgjn4QM5IN2i5fAZ4xKop47pr8rpVhiAeu+nDQa12C8+g==", - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-syntax-jsx": "^7.27.1", - "@babel/plugin-transform-modules-commonjs": "^7.27.1", - "@babel/plugin-transform-typescript": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/runtime": { - "version": "7.29.2", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.29.2.tgz", - "integrity": "sha512-JiDShH45zKHWyGe4ZNVRrCjBz8Nh9TMmZG1kh4QTK8hCBTWBi8Da+i7s1fJw7/lYpM4ccepSNfqzZ/QvABBi5g==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/runtime-corejs3": { - "version": "7.29.2", - "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.29.2.tgz", - "integrity": "sha512-Lc94FOD5+0aXhdb0Tdg3RUtqT6yWbI/BbFWvlaSJ3gAb9Ks+99nHRDKADVqC37er4eCB0fHyWT+y+K3QOvJKbw==", - "license": "MIT", - "dependencies": { - "core-js-pure": "^3.48.0" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/template": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.28.6.tgz", - "integrity": "sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==", - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.28.6", - "@babel/parser": "^7.28.6", - "@babel/types": "^7.28.6" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/traverse": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.0.tgz", - "integrity": "sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA==", - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.29.0", - "@babel/generator": "^7.29.0", - "@babel/helper-globals": "^7.28.0", - "@babel/parser": "^7.29.0", - "@babel/template": "^7.28.6", - "@babel/types": "^7.29.0", - "debug": "^4.3.1" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@babel/types": { - "version": "7.29.0", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", - "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", - "license": "MIT", - "dependencies": { - "@babel/helper-string-parser": "^7.27.1", - "@babel/helper-validator-identifier": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/@colors/colors": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", - "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", - "license": "MIT", - "optional": true, - "engines": { - "node": ">=0.1.90" - } - }, - "node_modules/@csstools/cascade-layer-name-parser": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz", - "integrity": "sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/color-helpers": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", - "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - } - }, - "node_modules/@csstools/css-calc": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", - "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/css-color-parser": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", - "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/color-helpers": "^5.1.0", - "@csstools/css-calc": "^2.1.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/css-parser-algorithms": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", - "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/css-tokenizer": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", - "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - } - }, - "node_modules/@csstools/media-query-list-parser": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz", - "integrity": "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/postcss-alpha-function": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-alpha-function/-/postcss-alpha-function-1.0.1.tgz", - "integrity": "sha512-isfLLwksH3yHkFXfCI2Gcaqg7wGGHZZwunoJzEZk0yKYIokgre6hYVFibKL3SYAoR1kBXova8LB+JoO5vZzi9w==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-cascade-layers": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz", - "integrity": "sha512-nWBE08nhO8uWl6kSAeCx4im7QfVko3zLrtgWZY4/bP87zrSPpSyN/3W3TDqz1jJuH+kbKOHXg5rJnK+ZVYcFFg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/selector-specificity": "^5.0.0", - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-cascade-layers/node_modules/@csstools/selector-specificity": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", - "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/@csstools/postcss-cascade-layers/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/@csstools/postcss-color-function": { - "version": "4.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-color-function/-/postcss-color-function-4.0.12.tgz", - "integrity": "sha512-yx3cljQKRaSBc2hfh8rMZFZzChaFgwmO2JfFgFr1vMcF3C/uyy5I4RFIBOIWGq1D+XbKCG789CGkG6zzkLpagA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-color-function-display-p3-linear": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-color-function-display-p3-linear/-/postcss-color-function-display-p3-linear-1.0.1.tgz", - "integrity": "sha512-E5qusdzhlmO1TztYzDIi8XPdPoYOjoTY6HBYBCYSj+Gn4gQRBlvjgPQXzfzuPQqt8EhkC/SzPKObg4Mbn8/xMg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-color-mix-function": { - "version": "3.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.12.tgz", - "integrity": "sha512-4STERZfCP5Jcs13P1U5pTvI9SkgLgfMUMhdXW8IlJWkzOOOqhZIjcNhWtNJZes2nkBDsIKJ0CJtFtuaZ00moag==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-color-mix-variadic-function-arguments": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.2.tgz", - "integrity": "sha512-rM67Gp9lRAkTo+X31DUqMEq+iK+EFqsidfecmhrteErxJZb6tUoJBVQca1Vn1GpDql1s1rD1pKcuYzMsg7Z1KQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-content-alt-text": { - "version": "2.0.8", - "resolved": "https://registry.npmjs.org/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.8.tgz", - "integrity": "sha512-9SfEW9QCxEpTlNMnpSqFaHyzsiRpZ5J5+KqCu1u5/eEJAWsMhzT40qf0FIbeeglEvrGRMdDzAxMIz3wqoGSb+Q==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-contrast-color-function": { - "version": "2.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-contrast-color-function/-/postcss-contrast-color-function-2.0.12.tgz", - "integrity": "sha512-YbwWckjK3qwKjeYz/CijgcS7WDUCtKTd8ShLztm3/i5dhh4NaqzsbYnhm4bjrpFpnLZ31jVcbK8YL77z3GBPzA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-exponential-functions": { - "version": "2.0.9", - "resolved": "https://registry.npmjs.org/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz", - "integrity": "sha512-abg2W/PI3HXwS/CZshSa79kNWNZHdJPMBXeZNyPQFbbj8sKO3jXxOt/wF7juJVjyDTc6JrvaUZYFcSBZBhaxjw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-font-format-keywords": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-font-format-keywords/-/postcss-font-format-keywords-4.0.0.tgz", - "integrity": "sha512-usBzw9aCRDvchpok6C+4TXC57btc4bJtmKQWOHQxOVKen1ZfVqBUuCZ/wuqdX5GHsD0NRSr9XTP+5ID1ZZQBXw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-gamut-mapping": { - "version": "2.0.11", - "resolved": "https://registry.npmjs.org/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.11.tgz", - "integrity": "sha512-fCpCUgZNE2piVJKC76zFsgVW1apF6dpYsqGyH8SIeCcM4pTEsRTWTLCaJIMKFEundsCKwY1rwfhtrio04RJ4Dw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-gradients-interpolation-method": { - "version": "5.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.12.tgz", - "integrity": "sha512-jugzjwkUY0wtNrZlFeyXzimUL3hN4xMvoPnIXxoZqxDvjZRiSh+itgHcVUWzJ2VwD/VAMEgCLvtaJHX+4Vj3Ow==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-hwb-function": { - "version": "4.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.12.tgz", - "integrity": "sha512-mL/+88Z53KrE4JdePYFJAQWFrcADEqsLprExCM04GDNgHIztwFzj0Mbhd/yxMBngq0NIlz58VVxjt5abNs1VhA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-ic-unit": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.4.tgz", - "integrity": "sha512-yQ4VmossuOAql65sCPppVO1yfb7hDscf4GseF0VCA/DTDaBc0Wtf8MTqVPfjGYlT5+2buokG0Gp7y0atYZpwjg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-initial": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-initial/-/postcss-initial-2.0.1.tgz", - "integrity": "sha512-L1wLVMSAZ4wovznquK0xmC7QSctzO4D0Is590bxpGqhqjboLXYA16dWZpfwImkdOgACdQ9PqXsuRroW6qPlEsg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-is-pseudo-class": { - "version": "5.0.3", - "resolved": "https://registry.npmjs.org/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.3.tgz", - "integrity": "sha512-jS/TY4SpG4gszAtIg7Qnf3AS2pjcUM5SzxpApOrlndMeGhIbaTzWBzzP/IApXoNWEW7OhcjkRT48jnAUIFXhAQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/selector-specificity": "^5.0.0", - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-is-pseudo-class/node_modules/@csstools/selector-specificity": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", - "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/@csstools/postcss-is-pseudo-class/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/@csstools/postcss-light-dark-function": { - "version": "2.0.11", - "resolved": "https://registry.npmjs.org/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.11.tgz", - "integrity": "sha512-fNJcKXJdPM3Lyrbmgw2OBbaioU7yuKZtiXClf4sGdQttitijYlZMD5K7HrC/eF83VRWRrYq6OZ0Lx92leV2LFA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-float-and-clear": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-float-and-clear/-/postcss-logical-float-and-clear-3.0.0.tgz", - "integrity": "sha512-SEmaHMszwakI2rqKRJgE+8rpotFfne1ZS6bZqBoQIicFyV+xT1UF42eORPxJkVJVrH9C0ctUgwMSn3BLOIZldQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-overflow": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-overflow/-/postcss-logical-overflow-2.0.0.tgz", - "integrity": "sha512-spzR1MInxPuXKEX2csMamshR4LRaSZ3UXVaRGjeQxl70ySxOhMpP2252RAFsg8QyyBXBzuVOOdx1+bVO5bPIzA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-overscroll-behavior": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-overscroll-behavior/-/postcss-logical-overscroll-behavior-2.0.0.tgz", - "integrity": "sha512-e/webMjoGOSYfqLunyzByZj5KKe5oyVg/YSbie99VEaSDE2kimFm0q1f6t/6Jo+VVCQ/jbe2Xy+uX+C4xzWs4w==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-resize": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-resize/-/postcss-logical-resize-3.0.0.tgz", - "integrity": "sha512-DFbHQOFW/+I+MY4Ycd/QN6Dg4Hcbb50elIJCfnwkRTCX05G11SwViI5BbBlg9iHRl4ytB7pmY5ieAFk3ws7yyg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-viewport-units": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.4.tgz", - "integrity": "sha512-q+eHV1haXA4w9xBwZLKjVKAWn3W2CMqmpNpZUk5kRprvSiBEGMgrNH3/sJZ8UA3JgyHaOt3jwT9uFa4wLX4EqQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-media-minmax": { - "version": "2.0.9", - "resolved": "https://registry.npmjs.org/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz", - "integrity": "sha512-af9Qw3uS3JhYLnCbqtZ9crTvvkR+0Se+bBqSr7ykAnl9yKhk6895z9rf+2F4dClIDJWxgn0iZZ1PSdkhrbs2ig==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/media-query-list-parser": "^4.0.3" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz", - "integrity": "sha512-zhAe31xaaXOY2Px8IYfoVTB3wglbJUVigGphFLj6exb7cjZRH9A6adyE22XfFK3P2PzwRk0VDeTJmaxpluyrDg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/media-query-list-parser": "^4.0.3" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-nested-calc": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-nested-calc/-/postcss-nested-calc-4.0.0.tgz", - "integrity": "sha512-jMYDdqrQQxE7k9+KjstC3NbsmC063n1FTPLCgCRS2/qHUbHM0mNy9pIn4QIiQGs9I/Bg98vMqw7mJXBxa0N88A==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-normalize-display-values": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-normalize-display-values/-/postcss-normalize-display-values-4.0.1.tgz", - "integrity": "sha512-TQUGBuRvxdc7TgNSTevYqrL8oItxiwPDixk20qCB5me/W8uF7BPbhRrAvFuhEoywQp/woRsUZ6SJ+sU5idZAIA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-oklab-function": { - "version": "4.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.12.tgz", - "integrity": "sha512-HhlSmnE1NKBhXsTnNGjxvhryKtO7tJd1w42DKOGFD6jSHtYOrsJTQDKPMwvOfrzUAk8t7GcpIfRyM7ssqHpFjg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-position-area-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-position-area-property/-/postcss-position-area-property-1.0.0.tgz", - "integrity": "sha512-fUP6KR8qV2NuUZV3Cw8itx0Ep90aRjAZxAEzC3vrl6yjFv+pFsQbR18UuQctEKmA72K9O27CoYiKEgXxkqjg8Q==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-progressive-custom-properties": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.2.1.tgz", - "integrity": "sha512-uPiiXf7IEKtUQXsxu6uWtOlRMXd2QWWy5fhxHDnPdXKCQckPP3E34ZgDoZ62r2iT+UOgWsSbM4NvHE5m3mAEdw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-property-rule-prelude-list": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-property-rule-prelude-list/-/postcss-property-rule-prelude-list-1.0.0.tgz", - "integrity": "sha512-IxuQjUXq19fobgmSSvUDO7fVwijDJaZMvWQugxfEUxmjBeDCVaDuMpsZ31MsTm5xbnhA+ElDi0+rQ7sQQGisFA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-random-function": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz", - "integrity": "sha512-q+FQaNiRBhnoSNo+GzqGOIBKoHQ43lYz0ICrV+UudfWnEF6ksS6DsBIJSISKQT2Bvu3g4k6r7t0zYrk5pDlo8w==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-relative-color-syntax": { - "version": "3.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.12.tgz", - "integrity": "sha512-0RLIeONxu/mtxRtf3o41Lq2ghLimw0w9ByLWnnEVuy89exmEEq8bynveBxNW3nyHqLAFEeNtVEmC1QK9MZ8Huw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-scope-pseudo-class": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-scope-pseudo-class/-/postcss-scope-pseudo-class-4.0.1.tgz", - "integrity": "sha512-IMi9FwtH6LMNuLea1bjVMQAsUhFxJnyLSgOp/cpv5hrzWmrUYU5fm0EguNDIIOHUqzXode8F/1qkC/tEo/qN8Q==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-scope-pseudo-class/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/@csstools/postcss-sign-functions": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.4.tgz", - "integrity": "sha512-P97h1XqRPcfcJndFdG95Gv/6ZzxUBBISem0IDqPZ7WMvc/wlO+yU0c5D/OCpZ5TJoTt63Ok3knGk64N+o6L2Pg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-stepped-value-functions": { - "version": "4.0.9", - "resolved": "https://registry.npmjs.org/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz", - "integrity": "sha512-h9btycWrsex4dNLeQfyU3y3w40LMQooJWFMm/SK9lrKguHDcFl4VMkncKKoXi2z5rM9YGWbUQABI8BT2UydIcA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-syntax-descriptor-syntax-production": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-syntax-descriptor-syntax-production/-/postcss-syntax-descriptor-syntax-production-1.0.1.tgz", - "integrity": "sha512-GneqQWefjM//f4hJ/Kbox0C6f2T7+pi4/fqTqOFGTL3EjnvOReTqO1qUQ30CaUjkwjYq9qZ41hzarrAxCc4gow==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-system-ui-font-family": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-system-ui-font-family/-/postcss-system-ui-font-family-1.0.0.tgz", - "integrity": "sha512-s3xdBvfWYfoPSBsikDXbuorcMG1nN1M6GdU0qBsGfcmNR0A/qhloQZpTxjA3Xsyrk1VJvwb2pOfiOT3at/DuIQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-text-decoration-shorthand": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz", - "integrity": "sha512-KSkGgZfx0kQjRIYnpsD7X2Om9BUXX/Kii77VBifQW9Ih929hK0KNjVngHDH0bFB9GmfWcR9vJYJJRvw/NQjkrA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/color-helpers": "^5.1.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-trigonometric-functions": { - "version": "4.0.9", - "resolved": "https://registry.npmjs.org/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz", - "integrity": "sha512-Hnh5zJUdpNrJqK9v1/E3BbrQhaDTj5YiX7P61TOvUhoDHnUmsNNxcDAgkQ32RrcWx9GVUvfUNPcUkn8R3vIX6A==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-unset-value": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz", - "integrity": "sha512-cBz3tOCI5Fw6NIFEwU3RiwK6mn3nKegjpJuzCndoGq3BZPkUjnsq7uQmIeMNeMbMk7YD2MfKcgCpZwX5jyXqCA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/utilities": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@csstools/utilities/-/utilities-2.0.0.tgz", - "integrity": "sha512-5VdOr0Z71u+Yp3ozOx8T11N703wIFGVRgOWbOZMKgglPJsWA54MRIoMNVMa7shUToIhx5J8vX4sOZgD2XiihiQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@discoveryjs/json-ext": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz", - "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", - "license": "MIT", - "engines": { - "node": ">=10.0.0" - } - }, - "node_modules/@docsearch/core": { - "version": "4.6.2", - "resolved": "https://registry.npmjs.org/@docsearch/core/-/core-4.6.2.tgz", - "integrity": "sha512-/S0e6Dj7Zcm8m9Rru49YEX49dhU11be68c+S/BCyN8zQsTTgkKzXlhRbVL5mV6lOLC2+ZRRryaTdcm070Ug2oA==", - "license": "MIT", - "peerDependencies": { - "@types/react": ">= 16.8.0 < 20.0.0", - "react": ">= 16.8.0 < 20.0.0", - "react-dom": ">= 16.8.0 < 20.0.0" - }, - "peerDependenciesMeta": { - "@types/react": { - "optional": true - }, - "react": { - "optional": true - }, - "react-dom": { - "optional": true - } - } - }, - "node_modules/@docsearch/css": { - "version": "4.6.2", - "resolved": "https://registry.npmjs.org/@docsearch/css/-/css-4.6.2.tgz", - "integrity": "sha512-fH/cn8BjEEdM2nJdjNMHIvOVYupG6AIDtFVDgIZrNzdCSj4KXr9kd+hsehqsNGYjpUjObeKYKvgy/IwCb1jZYQ==", - "license": "MIT" - }, - "node_modules/@docsearch/react": { - "version": "4.6.2", - "resolved": "https://registry.npmjs.org/@docsearch/react/-/react-4.6.2.tgz", - "integrity": "sha512-/BbtGFtqVOGwZx0dw/UfhN/0/DmMQYnulY4iv0tPRhC2JCXv0ka/+izwt3Jzo1ZxXS/2eMvv9zHsBJOK1I9f/w==", - "license": "MIT", - "dependencies": { - "@algolia/autocomplete-core": "1.19.2", - "@docsearch/core": "4.6.2", - "@docsearch/css": "4.6.2" - }, - "peerDependencies": { - "@types/react": ">= 16.8.0 < 20.0.0", - "react": ">= 16.8.0 < 20.0.0", - "react-dom": ">= 16.8.0 < 20.0.0", - "search-insights": ">= 1 < 3" - }, - "peerDependenciesMeta": { - "@types/react": { - "optional": true - }, - "react": { - "optional": true - }, - "react-dom": { - "optional": true - }, - "search-insights": { - "optional": true - } - } - }, - "node_modules/@docusaurus/babel": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/babel/-/babel-3.9.2.tgz", - "integrity": "sha512-GEANdi/SgER+L7Japs25YiGil/AUDnFFHaCGPBbundxoWtCkA2lmy7/tFmgED4y1htAy6Oi4wkJEQdGssnw9MA==", - "license": "MIT", - "dependencies": { - "@babel/core": "^7.25.9", - "@babel/generator": "^7.25.9", - "@babel/plugin-syntax-dynamic-import": "^7.8.3", - "@babel/plugin-transform-runtime": "^7.25.9", - "@babel/preset-env": "^7.25.9", - "@babel/preset-react": "^7.25.9", - "@babel/preset-typescript": "^7.25.9", - "@babel/runtime": "^7.25.9", - "@babel/runtime-corejs3": "^7.25.9", - "@babel/traverse": "^7.25.9", - "@docusaurus/logger": "3.9.2", - "@docusaurus/utils": "3.9.2", - "babel-plugin-dynamic-import-node": "^2.3.3", - "fs-extra": "^11.1.1", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/bundler": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/bundler/-/bundler-3.9.2.tgz", - "integrity": "sha512-ZOVi6GYgTcsZcUzjblpzk3wH1Fya2VNpd5jtHoCCFcJlMQ1EYXZetfAnRHLcyiFeBABaI1ltTYbOBtH/gahGVA==", - "license": "MIT", - "dependencies": { - "@babel/core": "^7.25.9", - "@docusaurus/babel": "3.9.2", - "@docusaurus/cssnano-preset": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "babel-loader": "^9.2.1", - "clean-css": "^5.3.3", - "copy-webpack-plugin": "^11.0.0", - "css-loader": "^6.11.0", - "css-minimizer-webpack-plugin": "^5.0.1", - "cssnano": "^6.1.2", - "file-loader": "^6.2.0", - "html-minifier-terser": "^7.2.0", - "mini-css-extract-plugin": "^2.9.2", - "null-loader": "^4.0.1", - "postcss": "^8.5.4", - "postcss-loader": "^7.3.4", - "postcss-preset-env": "^10.2.1", - "terser-webpack-plugin": "^5.3.9", - "tslib": "^2.6.0", - "url-loader": "^4.1.1", - "webpack": "^5.95.0", - "webpackbar": "^6.0.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "@docusaurus/faster": "*" - }, - "peerDependenciesMeta": { - "@docusaurus/faster": { - "optional": true - } - } - }, - "node_modules/@docusaurus/core": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/core/-/core-3.9.2.tgz", - "integrity": "sha512-HbjwKeC+pHUFBfLMNzuSjqFE/58+rLVKmOU3lxQrpsxLBOGosYco/Q0GduBb0/jEMRiyEqjNT/01rRdOMWq5pw==", - "license": "MIT", - "dependencies": { - "@docusaurus/babel": "3.9.2", - "@docusaurus/bundler": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "boxen": "^6.2.1", - "chalk": "^4.1.2", - "chokidar": "^3.5.3", - "cli-table3": "^0.6.3", - "combine-promises": "^1.1.0", - "commander": "^5.1.0", - "core-js": "^3.31.1", - "detect-port": "^1.5.1", - "escape-html": "^1.0.3", - "eta": "^2.2.0", - "eval": "^0.1.8", - "execa": "5.1.1", - "fs-extra": "^11.1.1", - "html-tags": "^3.3.1", - "html-webpack-plugin": "^5.6.0", - "leven": "^3.1.0", - "lodash": "^4.17.21", - "open": "^8.4.0", - "p-map": "^4.0.0", - "prompts": "^2.4.2", - "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", - "react-loadable": "npm:@docusaurus/react-loadable@6.0.0", - "react-loadable-ssr-addon-v5-slorber": "^1.0.1", - "react-router": "^5.3.4", - "react-router-config": "^5.1.1", - "react-router-dom": "^5.3.4", - "semver": "^7.5.4", - "serve-handler": "^6.1.6", - "tinypool": "^1.0.2", - "tslib": "^2.6.0", - "update-notifier": "^6.0.2", - "webpack": "^5.95.0", - "webpack-bundle-analyzer": "^4.10.2", - "webpack-dev-server": "^5.2.2", - "webpack-merge": "^6.0.1" - }, - "bin": { - "docusaurus": "bin/docusaurus.mjs" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "@mdx-js/react": "^3.0.0", - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/cssnano-preset": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/cssnano-preset/-/cssnano-preset-3.9.2.tgz", - "integrity": "sha512-8gBKup94aGttRduABsj7bpPFTX7kbwu+xh3K9NMCF5K4bWBqTFYW+REKHF6iBVDHRJ4grZdIPbvkiHd/XNKRMQ==", - "license": "MIT", - "dependencies": { - "cssnano-preset-advanced": "^6.1.2", - "postcss": "^8.5.4", - "postcss-sort-media-queries": "^5.2.0", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/logger": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/logger/-/logger-3.9.2.tgz", - "integrity": "sha512-/SVCc57ByARzGSU60c50rMyQlBuMIJCjcsJlkphxY6B0GV4UH3tcA1994N8fFfbJ9kX3jIBe/xg3XP5qBtGDbA==", - "license": "MIT", - "dependencies": { - "chalk": "^4.1.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/mdx-loader": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/mdx-loader/-/mdx-loader-3.9.2.tgz", - "integrity": "sha512-wiYoGwF9gdd6rev62xDU8AAM8JuLI/hlwOtCzMmYcspEkzecKrP8J8X+KpYnTlACBUUtXNJpSoCwFWJhLRevzQ==", - "license": "MIT", - "dependencies": { - "@docusaurus/logger": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@mdx-js/mdx": "^3.0.0", - "@slorber/remark-comment": "^1.0.0", - "escape-html": "^1.0.3", - "estree-util-value-to-estree": "^3.0.1", - "file-loader": "^6.2.0", - "fs-extra": "^11.1.1", - "image-size": "^2.0.2", - "mdast-util-mdx": "^3.0.0", - "mdast-util-to-string": "^4.0.0", - "rehype-raw": "^7.0.0", - "remark-directive": "^3.0.0", - "remark-emoji": "^4.0.0", - "remark-frontmatter": "^5.0.0", - "remark-gfm": "^4.0.0", - "stringify-object": "^3.3.0", - "tslib": "^2.6.0", - "unified": "^11.0.3", - "unist-util-visit": "^5.0.0", - "url-loader": "^4.1.1", - "vfile": "^6.0.1", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/module-type-aliases": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/module-type-aliases/-/module-type-aliases-3.9.2.tgz", - "integrity": "sha512-8qVe2QA9hVLzvnxP46ysuofJUIc/yYQ82tvA/rBTrnpXtCjNSFLxEZfd5U8cYZuJIVlkPxamsIgwd5tGZXfvew==", - "license": "MIT", - "dependencies": { - "@docusaurus/types": "3.9.2", - "@types/history": "^4.7.11", - "@types/react": "*", - "@types/react-router-config": "*", - "@types/react-router-dom": "*", - "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", - "react-loadable": "npm:@docusaurus/react-loadable@6.0.0" - }, - "peerDependencies": { - "react": "*", - "react-dom": "*" - } - }, - "node_modules/@docusaurus/plugin-content-blog": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.9.2.tgz", - "integrity": "sha512-3I2HXy3L1QcjLJLGAoTvoBnpOwa6DPUa3Q0dMK19UTY9mhPkKQg/DYhAGTiBUKcTR0f08iw7kLPqOhIgdV3eVQ==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "cheerio": "1.0.0-rc.12", - "feed": "^4.2.2", - "fs-extra": "^11.1.1", - "lodash": "^4.17.21", - "schema-dts": "^1.1.2", - "srcset": "^4.0.0", - "tslib": "^2.6.0", - "unist-util-visit": "^5.0.0", - "utility-types": "^3.10.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "@docusaurus/plugin-content-docs": "*", - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-content-docs": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz", - "integrity": "sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@types/react-router-config": "^5.0.7", - "combine-promises": "^1.1.0", - "fs-extra": "^11.1.1", - "js-yaml": "^4.1.0", - "lodash": "^4.17.21", - "schema-dts": "^1.1.2", - "tslib": "^2.6.0", - "utility-types": "^3.10.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-content-pages": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.9.2.tgz", - "integrity": "sha512-s4849w/p4noXUrGpPUF0BPqIAfdAe76BLaRGAGKZ1gTDNiGxGcpsLcwJ9OTi1/V8A+AzvsmI9pkjie2zjIQZKA==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "fs-extra": "^11.1.1", - "tslib": "^2.6.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-css-cascade-layers": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.9.2.tgz", - "integrity": "sha512-w1s3+Ss+eOQbscGM4cfIFBlVg/QKxyYgj26k5AnakuHkKxH6004ZtuLe5awMBotIYF2bbGDoDhpgQ4r/kcj4rQ==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/plugin-debug": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-debug/-/plugin-debug-3.9.2.tgz", - "integrity": "sha512-j7a5hWuAFxyQAkilZwhsQ/b3T7FfHZ+0dub6j/GxKNFJp2h9qk/P1Bp7vrGASnvA9KNQBBL1ZXTe7jlh4VdPdA==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "fs-extra": "^11.1.1", - "react-json-view-lite": "^2.3.0", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-google-analytics": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.9.2.tgz", - "integrity": "sha512-mAwwQJ1Us9jL/lVjXtErXto4p4/iaLlweC54yDUK1a97WfkC6Z2k5/769JsFgwOwOP+n5mUQGACXOEQ0XDuVUw==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-google-gtag": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.9.2.tgz", - "integrity": "sha512-YJ4lDCphabBtw19ooSlc1MnxtYGpjFV9rEdzjLsUnBCeis2djUyCozZaFhCg6NGEwOn7HDDyMh0yzcdRpnuIvA==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@types/gtag.js": "^0.0.12", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-google-tag-manager": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.9.2.tgz", - "integrity": "sha512-LJtIrkZN/tuHD8NqDAW1Tnw0ekOwRTfobWPsdO15YxcicBo2ykKF0/D6n0vVBfd3srwr9Z6rzrIWYrMzBGrvNw==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-sitemap": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.9.2.tgz", - "integrity": "sha512-WLh7ymgDXjG8oPoM/T4/zUP7KcSuFYRZAUTl8vR6VzYkfc18GBM4xLhcT+AKOwun6kBivYKUJf+vlqYJkm+RHw==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "fs-extra": "^11.1.1", - "sitemap": "^7.1.1", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-svgr": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-svgr/-/plugin-svgr-3.9.2.tgz", - "integrity": "sha512-n+1DE+5b3Lnf27TgVU5jM1d4x5tUh2oW5LTsBxJX4PsAPV0JGcmI6p3yLYtEY0LRVEIJh+8RsdQmRE66wSV8mw==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@svgr/core": "8.1.0", - "@svgr/webpack": "^8.1.0", - "tslib": "^2.6.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/preset-classic": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/preset-classic/-/preset-classic-3.9.2.tgz", - "integrity": "sha512-IgyYO2Gvaigi21LuDIe+nvmN/dfGXAiMcV/murFqcpjnZc7jxFAxW+9LEjdPt61uZLxG4ByW/oUmX/DDK9t/8w==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/plugin-content-blog": "3.9.2", - "@docusaurus/plugin-content-docs": "3.9.2", - "@docusaurus/plugin-content-pages": "3.9.2", - "@docusaurus/plugin-css-cascade-layers": "3.9.2", - "@docusaurus/plugin-debug": "3.9.2", - "@docusaurus/plugin-google-analytics": "3.9.2", - "@docusaurus/plugin-google-gtag": "3.9.2", - "@docusaurus/plugin-google-tag-manager": "3.9.2", - "@docusaurus/plugin-sitemap": "3.9.2", - "@docusaurus/plugin-svgr": "3.9.2", - "@docusaurus/theme-classic": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/theme-search-algolia": "3.9.2", - "@docusaurus/types": "3.9.2" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/theme-classic": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/theme-classic/-/theme-classic-3.9.2.tgz", - "integrity": "sha512-IGUsArG5hhekXd7RDb11v94ycpJpFdJPkLnt10fFQWOVxAtq5/D7hT6lzc2fhyQKaaCE62qVajOMKL7OiAFAIA==", - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/plugin-content-blog": "3.9.2", - "@docusaurus/plugin-content-docs": "3.9.2", - "@docusaurus/plugin-content-pages": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/theme-translations": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@mdx-js/react": "^3.0.0", - "clsx": "^2.0.0", - "infima": "0.2.0-alpha.45", - "lodash": "^4.17.21", - "nprogress": "^0.2.0", - "postcss": "^8.5.4", - "prism-react-renderer": "^2.3.0", - "prismjs": "^1.29.0", - "react-router-dom": "^5.3.4", - "rtlcss": "^4.1.0", - "tslib": "^2.6.0", - "utility-types": "^3.10.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/theme-common": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.9.2.tgz", - "integrity": "sha512-6c4DAbR6n6nPbnZhY2V3tzpnKnGL+6aOsLvFL26VRqhlczli9eWG0VDUNoCQEPnGwDMhPS42UhSAnz5pThm5Ag==", - "license": "MIT", - "dependencies": { - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@types/history": "^4.7.11", - "@types/react": "*", - "@types/react-router-config": "*", - "clsx": "^2.0.0", - "parse-numeric-range": "^1.3.0", - "prism-react-renderer": "^2.3.0", - "tslib": "^2.6.0", - "utility-types": "^3.10.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "@docusaurus/plugin-content-docs": "*", - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/theme-search-algolia": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.9.2.tgz", - "integrity": "sha512-GBDSFNwjnh5/LdkxCKQHkgO2pIMX1447BxYUBG2wBiajS21uj64a+gH/qlbQjDLxmGrbrllBrtJkUHxIsiwRnw==", - "license": "MIT", - "dependencies": { - "@docsearch/react": "^3.9.0 || ^4.1.0", - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/plugin-content-docs": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/theme-translations": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "algoliasearch": "^5.37.0", - "algoliasearch-helper": "^3.26.0", - "clsx": "^2.0.0", - "eta": "^2.2.0", - "fs-extra": "^11.1.1", - "lodash": "^4.17.21", - "tslib": "^2.6.0", - "utility-types": "^3.10.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/theme-translations": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/theme-translations/-/theme-translations-3.9.2.tgz", - "integrity": "sha512-vIryvpP18ON9T9rjgMRFLr2xJVDpw1rtagEGf8Ccce4CkTrvM/fRB8N2nyWYOW5u3DdjkwKw5fBa+3tbn9P4PA==", - "license": "MIT", - "dependencies": { - "fs-extra": "^11.1.1", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/tsconfig": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/tsconfig/-/tsconfig-3.9.2.tgz", - "integrity": "sha512-j6/Fp4Rlpxsc632cnRnl5HpOWeb6ZKssDj6/XzzAzVGXXfm9Eptx3rxCC+fDzySn9fHTS+CWJjPineCR1bB5WQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/@docusaurus/types": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/types/-/types-3.9.2.tgz", - "integrity": "sha512-Ux1JUNswg+EfUEmajJjyhIohKceitY/yzjRUpu04WXgvVz+fbhVC0p+R0JhvEu4ytw8zIAys2hrdpQPBHRIa8Q==", - "license": "MIT", - "dependencies": { - "@mdx-js/mdx": "^3.0.0", - "@types/history": "^4.7.11", - "@types/mdast": "^4.0.2", - "@types/react": "*", - "commander": "^5.1.0", - "joi": "^17.9.2", - "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", - "utility-types": "^3.10.0", - "webpack": "^5.95.0", - "webpack-merge": "^5.9.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/types/node_modules/webpack-merge": { - "version": "5.10.0", - "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz", - "integrity": "sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA==", - "license": "MIT", - "dependencies": { - "clone-deep": "^4.0.1", - "flat": "^5.0.2", - "wildcard": "^2.0.0" - }, - "engines": { - "node": ">=10.0.0" - } - }, - "node_modules/@docusaurus/utils": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/utils/-/utils-3.9.2.tgz", - "integrity": "sha512-lBSBiRruFurFKXr5Hbsl2thmGweAPmddhF3jb99U4EMDA5L+e5Y1rAkOS07Nvrup7HUMBDrCV45meaxZnt28nQ==", - "license": "MIT", - "dependencies": { - "@docusaurus/logger": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "escape-string-regexp": "^4.0.0", - "execa": "5.1.1", - "file-loader": "^6.2.0", - "fs-extra": "^11.1.1", - "github-slugger": "^1.5.0", - "globby": "^11.1.0", - "gray-matter": "^4.0.3", - "jiti": "^1.20.0", - "js-yaml": "^4.1.0", - "lodash": "^4.17.21", - "micromatch": "^4.0.5", - "p-queue": "^6.6.2", - "prompts": "^2.4.2", - "resolve-pathname": "^3.0.0", - "tslib": "^2.6.0", - "url-loader": "^4.1.1", - "utility-types": "^3.10.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/utils-common": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/utils-common/-/utils-common-3.9.2.tgz", - "integrity": "sha512-I53UC1QctruA6SWLvbjbhCpAw7+X7PePoe5pYcwTOEXD/PxeP8LnECAhTHHwWCblyUX5bMi4QLRkxvyZ+IT8Aw==", - "license": "MIT", - "dependencies": { - "@docusaurus/types": "3.9.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/utils-validation": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/utils-validation/-/utils-validation-3.9.2.tgz", - "integrity": "sha512-l7yk3X5VnNmATbwijJkexdhulNsQaNDwoagiwujXoxFbWLcxHQqNQ+c/IAlzrfMMOfa/8xSBZ7KEKDesE/2J7A==", - "license": "MIT", - "dependencies": { - "@docusaurus/logger": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "fs-extra": "^11.2.0", - "joi": "^17.9.2", - "js-yaml": "^4.1.0", - "lodash": "^4.17.21", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@easyops-cn/autocomplete.js": { - "version": "0.38.1", - "resolved": "https://registry.npmjs.org/@easyops-cn/autocomplete.js/-/autocomplete.js-0.38.1.tgz", - "integrity": "sha512-drg76jS6syilOUmVNkyo1c7ZEBPcPuK+aJA7AksM5ZIIbV57DMHCywiCr+uHyv8BE5jUTU98j/H7gVrkHrWW3Q==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "immediate": "^3.2.3" - } - }, - "node_modules/@easyops-cn/docusaurus-search-local": { - "version": "0.55.1", - "resolved": "https://registry.npmjs.org/@easyops-cn/docusaurus-search-local/-/docusaurus-search-local-0.55.1.tgz", - "integrity": "sha512-jmBKj1J+tajqNrCvECwKCQYTWwHVZDGApy8lLOYEPe+Dm0/f3Ccdw8BP5/OHNpltr7WDNY2roQXn+TWn2f1kig==", - "license": "MIT", - "dependencies": { - "@docusaurus/plugin-content-docs": "^2 || ^3", - "@docusaurus/theme-translations": "^2 || ^3", - "@docusaurus/utils": "^2 || ^3", - "@docusaurus/utils-common": "^2 || ^3", - "@docusaurus/utils-validation": "^2 || ^3", - "@easyops-cn/autocomplete.js": "^0.38.1", - "@node-rs/jieba": "^1.6.0", - "cheerio": "^1.0.0", - "clsx": "^2.1.1", - "comlink": "^4.4.2", - "debug": "^4.2.0", - "fs-extra": "^10.0.0", - "klaw-sync": "^6.0.0", - "lunr": "^2.3.9", - "lunr-languages": "^1.4.0", - "mark.js": "^8.11.1", - "tslib": "^2.4.0" - }, - "engines": { - "node": ">=12" - }, - "peerDependencies": { - "@docusaurus/theme-common": "^2 || ^3", - "open-ask-ai": "^0.7.3", - "react": "^16.14.0 || ^17 || ^18 || ^19", - "react-dom": "^16.14.0 || 17 || ^18 || ^19" - }, - "peerDependenciesMeta": { - "open-ask-ai": { - "optional": true - } - } - }, - "node_modules/@easyops-cn/docusaurus-search-local/node_modules/cheerio": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.2.0.tgz", - "integrity": "sha512-WDrybc/gKFpTYQutKIK6UvfcuxijIZfMfXaYm8NMsPQxSYvf+13fXUJ4rztGGbJcBQ/GF55gvrZ0Bc0bj/mqvg==", - "license": "MIT", - "dependencies": { - "cheerio-select": "^2.1.0", - "dom-serializer": "^2.0.0", - "domhandler": "^5.0.3", - "domutils": "^3.2.2", - "encoding-sniffer": "^0.2.1", - "htmlparser2": "^10.1.0", - "parse5": "^7.3.0", - "parse5-htmlparser2-tree-adapter": "^7.1.0", - "parse5-parser-stream": "^7.1.2", - "undici": "^7.19.0", - "whatwg-mimetype": "^4.0.0" - }, - "engines": { - "node": ">=20.18.1" - }, - "funding": { - "url": "https://github.com/cheeriojs/cheerio?sponsor=1" - } - }, - "node_modules/@easyops-cn/docusaurus-search-local/node_modules/entities": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz", - "integrity": "sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==", - "license": "BSD-2-Clause", - "engines": { - "node": ">=0.12" - }, - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, - "node_modules/@easyops-cn/docusaurus-search-local/node_modules/fs-extra": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", - "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/@easyops-cn/docusaurus-search-local/node_modules/htmlparser2": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.1.0.tgz", - "integrity": "sha512-VTZkM9GWRAtEpveh7MSF6SjjrpNVNNVJfFup7xTY3UpFtm67foy9HDVXneLtFVt4pMz5kZtgNcvCniNFb1hlEQ==", - "funding": [ - "https://github.com/fb55/htmlparser2?sponsor=1", - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ], - "license": "MIT", - "dependencies": { - "domelementtype": "^2.3.0", - "domhandler": "^5.0.3", - "domutils": "^3.2.2", - "entities": "^7.0.1" - } - }, - "node_modules/@emnapi/core": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.9.1.tgz", - "integrity": "sha512-mukuNALVsoix/w1BJwFzwXBN/dHeejQtuVzcDsfOEsdpCumXb/E9j8w11h5S54tT1xhifGfbbSm/ICrObRb3KA==", - "license": "MIT", - "optional": true, - "dependencies": { - "@emnapi/wasi-threads": "1.2.0", - "tslib": "^2.4.0" - } - }, - "node_modules/@emnapi/runtime": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.9.1.tgz", - "integrity": "sha512-VYi5+ZVLhpgK4hQ0TAjiQiZ6ol0oe4mBx7mVv7IflsiEp0OWoVsp/+f9Vc1hOhE0TtkORVrI1GvzyreqpgWtkA==", - "license": "MIT", - "optional": true, - "dependencies": { - "tslib": "^2.4.0" - } - }, - "node_modules/@emnapi/wasi-threads": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.2.0.tgz", - "integrity": "sha512-N10dEJNSsUx41Z6pZsXU8FjPjpBEplgH24sfkmITrBED1/U2Esum9F3lfLrMjKHHjmi557zQn7kR9R+XWXu5Rg==", - "license": "MIT", - "optional": true, - "dependencies": { - "tslib": "^2.4.0" - } - }, - "node_modules/@gerrit0/mini-shiki": { - "version": "3.23.0", - "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.23.0.tgz", - "integrity": "sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@shikijs/engine-oniguruma": "^3.23.0", - "@shikijs/langs": "^3.23.0", - "@shikijs/themes": "^3.23.0", - "@shikijs/types": "^3.23.0", - "@shikijs/vscode-textmate": "^10.0.2" - } - }, - "node_modules/@hapi/hoek": { - "version": "9.3.0", - "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", - "integrity": "sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==", - "license": "BSD-3-Clause" - }, - "node_modules/@hapi/topo": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/@hapi/topo/-/topo-5.1.0.tgz", - "integrity": "sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==", - "license": "BSD-3-Clause", - "dependencies": { - "@hapi/hoek": "^9.0.0" - } - }, - "node_modules/@jest/schemas": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", - "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", - "license": "MIT", - "dependencies": { - "@sinclair/typebox": "^0.27.8" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jest/types": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.6.3.tgz", - "integrity": "sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==", - "license": "MIT", - "dependencies": { - "@jest/schemas": "^29.6.3", - "@types/istanbul-lib-coverage": "^2.0.0", - "@types/istanbul-reports": "^3.0.0", - "@types/node": "*", - "@types/yargs": "^17.0.8", - "chalk": "^4.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/@jridgewell/gen-mapping": { - "version": "0.3.13", - "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", - "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", - "license": "MIT", - "dependencies": { - "@jridgewell/sourcemap-codec": "^1.5.0", - "@jridgewell/trace-mapping": "^0.3.24" - } - }, - "node_modules/@jridgewell/remapping": { - "version": "2.3.5", - "resolved": "https://registry.npmjs.org/@jridgewell/remapping/-/remapping-2.3.5.tgz", - "integrity": "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==", - "license": "MIT", - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.24" - } - }, - "node_modules/@jridgewell/resolve-uri": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", - "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", - "license": "MIT", - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@jridgewell/source-map": { - "version": "0.3.11", - "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.11.tgz", - "integrity": "sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA==", - "license": "MIT", - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.25" - } - }, - "node_modules/@jridgewell/sourcemap-codec": { - "version": "1.5.5", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", - "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", - "license": "MIT" - }, - "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.31", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", - "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", - "license": "MIT", - "dependencies": { - "@jridgewell/resolve-uri": "^3.1.0", - "@jridgewell/sourcemap-codec": "^1.4.14" - } - }, - "node_modules/@jsonjoy.com/base64": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/base64/-/base64-1.1.2.tgz", - "integrity": "sha512-q6XAnWQDIMA3+FTiOYajoYqySkO+JSat0ytXGSuRdq9uXE7o92gzuQwQM14xaCRlBLGq3v5miDGC4vkVTn54xA==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/buffers": { - "version": "17.67.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-17.67.0.tgz", - "integrity": "sha512-tfExRpYxBvi32vPs9ZHaTjSP4fHAfzSmcahOfNxtvGHcyJel+aibkPlGeBB+7AoC6hL7lXIE++8okecBxx7lcw==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/codegen": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/codegen/-/codegen-1.0.0.tgz", - "integrity": "sha512-E8Oy+08cmCf0EK/NMxpaJZmOxPqM+6iSe2S4nlSBrPZOORoDJILxtbSUEDKQyTamm/BVAhIGllOBNU79/dwf0g==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-core": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-core/-/fs-core-4.57.1.tgz", - "integrity": "sha512-YrEi/ZPmgc+GfdO0esBF04qv8boK9Dg9WpRQw/+vM8Qt3nnVIJWIa8HwZ/LXVZ0DB11XUROM8El/7yYTJX+WtA==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/fs-node-builtins": "4.57.1", - "@jsonjoy.com/fs-node-utils": "4.57.1", - "thingies": "^2.5.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-fsa": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-fsa/-/fs-fsa-4.57.1.tgz", - "integrity": "sha512-ooEPvSW/HQDivPDPZMibHGKZf/QS4WRir1czGZmXmp3MsQqLECZEpN0JobrD8iV9BzsuwdIv+PxtWX9WpPLsIA==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/fs-core": "4.57.1", - "@jsonjoy.com/fs-node-builtins": "4.57.1", - "@jsonjoy.com/fs-node-utils": "4.57.1", - "thingies": "^2.5.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-node": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node/-/fs-node-4.57.1.tgz", - "integrity": "sha512-3YaKhP8gXEKN+2O49GLNfNb5l2gbnCFHyAaybbA2JkkbQP3dpdef7WcUaHAulg/c5Dg4VncHsA3NWAUSZMR5KQ==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/fs-core": "4.57.1", - "@jsonjoy.com/fs-node-builtins": "4.57.1", - "@jsonjoy.com/fs-node-utils": "4.57.1", - "@jsonjoy.com/fs-print": "4.57.1", - "@jsonjoy.com/fs-snapshot": "4.57.1", - "glob-to-regex.js": "^1.0.0", - "thingies": "^2.5.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-node-builtins": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-builtins/-/fs-node-builtins-4.57.1.tgz", - "integrity": "sha512-XHkFKQ5GSH3uxm8c3ZYXVrexGdscpWKIcMWKFQpMpMJc8gA3AwOMBJXJlgpdJqmrhPyQXxaY9nbkNeYpacC0Og==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-node-to-fsa": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-to-fsa/-/fs-node-to-fsa-4.57.1.tgz", - "integrity": "sha512-pqGHyWWzNck4jRfaGV39hkqpY5QjRUQ/nRbNT7FYbBa0xf4bDG+TE1Gt2KWZrSkrkZZDE3qZUjYMbjwSliX6pg==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/fs-fsa": "4.57.1", - "@jsonjoy.com/fs-node-builtins": "4.57.1", - "@jsonjoy.com/fs-node-utils": "4.57.1" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-node-utils": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-utils/-/fs-node-utils-4.57.1.tgz", - "integrity": "sha512-vp+7ZzIB8v43G+GLXTS4oDUSQmhAsRz532QmmWBbdYA20s465JvwhkSFvX9cVTqRRAQg+vZ7zWDaIEh0lFe2gw==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/fs-node-builtins": "4.57.1" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-print": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-print/-/fs-print-4.57.1.tgz", - "integrity": "sha512-Ynct7ZJmfk6qoXDOKfpovNA36ITUx8rChLmRQtW08J73VOiuNsU8PB6d/Xs7fxJC2ohWR3a5AqyjmLojfrw5yw==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/fs-node-utils": "4.57.1", - "tree-dump": "^1.1.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-snapshot": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-snapshot/-/fs-snapshot-4.57.1.tgz", - "integrity": "sha512-/oG8xBNFMbDXTq9J7vepSA1kerS5vpgd3p5QZSPd+nX59uwodGJftI51gDYyHRpP57P3WCQf7LHtBYPqwUg2Bg==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/buffers": "^17.65.0", - "@jsonjoy.com/fs-node-utils": "4.57.1", - "@jsonjoy.com/json-pack": "^17.65.0", - "@jsonjoy.com/util": "^17.65.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/base64": { - "version": "17.67.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/base64/-/base64-17.67.0.tgz", - "integrity": "sha512-5SEsJGsm15aP8TQGkDfJvz9axgPwAEm98S5DxOuYe8e1EbfajcDmgeXXzccEjh+mLnjqEKrkBdjHWS5vFNwDdw==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/codegen": { - "version": "17.67.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/codegen/-/codegen-17.67.0.tgz", - "integrity": "sha512-idnkUplROpdBOV0HMcwhsCUS5TRUi9poagdGs70A6S4ux9+/aPuKbh8+UYRTLYQHtXvAdNfQWXDqZEx5k4Dj2Q==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/json-pack": { - "version": "17.67.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pack/-/json-pack-17.67.0.tgz", - "integrity": "sha512-t0ejURcGaZsn1ClbJ/3kFqSOjlryd92eQY465IYrezsXmPcfHPE/av4twRSxf6WE+TkZgLY+71vCZbiIiFKA/w==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/base64": "17.67.0", - "@jsonjoy.com/buffers": "17.67.0", - "@jsonjoy.com/codegen": "17.67.0", - "@jsonjoy.com/json-pointer": "17.67.0", - "@jsonjoy.com/util": "17.67.0", - "hyperdyperid": "^1.2.0", - "thingies": "^2.5.0", - "tree-dump": "^1.1.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/json-pointer": { - "version": "17.67.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pointer/-/json-pointer-17.67.0.tgz", - "integrity": "sha512-+iqOFInH+QZGmSuaybBUNdh7yvNrXvqR+h3wjXm0N/3JK1EyyFAeGJvqnmQL61d1ARLlk/wJdFKSL+LHJ1eaUA==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/util": "17.67.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/util": { - "version": "17.67.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/util/-/util-17.67.0.tgz", - "integrity": "sha512-6+8xBaz1rLSohlGh68D1pdw3AwDi9xydm8QNlAFkvnavCJYSze+pxoW2VKP8p308jtlMRLs5NTHfPlZLd4w7ew==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/buffers": "17.67.0", - "@jsonjoy.com/codegen": "17.67.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/json-pack": { - "version": "1.21.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pack/-/json-pack-1.21.0.tgz", - "integrity": "sha512-+AKG+R2cfZMShzrF2uQw34v3zbeDYUqnQ+jg7ORic3BGtfw9p/+N6RJbq/kkV8JmYZaINknaEQ2m0/f693ZPpg==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/base64": "^1.1.2", - "@jsonjoy.com/buffers": "^1.2.0", - "@jsonjoy.com/codegen": "^1.0.0", - "@jsonjoy.com/json-pointer": "^1.0.2", - "@jsonjoy.com/util": "^1.9.0", - "hyperdyperid": "^1.2.0", - "thingies": "^2.5.0", - "tree-dump": "^1.1.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/json-pack/node_modules/@jsonjoy.com/buffers": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz", - "integrity": "sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/json-pointer": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pointer/-/json-pointer-1.0.2.tgz", - "integrity": "sha512-Fsn6wM2zlDzY1U+v4Nc8bo3bVqgfNTGcn6dMgs6FjrEnt4ZCe60o6ByKRjOGlI2gow0aE/Q41QOigdTqkyK5fg==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/codegen": "^1.0.0", - "@jsonjoy.com/util": "^1.9.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/util": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/util/-/util-1.9.0.tgz", - "integrity": "sha512-pLuQo+VPRnN8hfPqUTLTHk126wuYdXVxE6aDmjSeV4NCAgyxWbiOIeNJVtID3h1Vzpoi9m4jXezf73I6LgabgQ==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/buffers": "^1.0.0", - "@jsonjoy.com/codegen": "^1.0.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/util/node_modules/@jsonjoy.com/buffers": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz", - "integrity": "sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@leichtgewicht/ip-codec": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz", - "integrity": "sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw==", - "license": "MIT" - }, - "node_modules/@mdx-js/mdx": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/@mdx-js/mdx/-/mdx-3.1.1.tgz", - "integrity": "sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "@types/estree-jsx": "^1.0.0", - "@types/hast": "^3.0.0", - "@types/mdx": "^2.0.0", - "acorn": "^8.0.0", - "collapse-white-space": "^2.0.0", - "devlop": "^1.0.0", - "estree-util-is-identifier-name": "^3.0.0", - "estree-util-scope": "^1.0.0", - "estree-walker": "^3.0.0", - "hast-util-to-jsx-runtime": "^2.0.0", - "markdown-extensions": "^2.0.0", - "recma-build-jsx": "^1.0.0", - "recma-jsx": "^1.0.0", - "recma-stringify": "^1.0.0", - "rehype-recma": "^1.0.0", - "remark-mdx": "^3.0.0", - "remark-parse": "^11.0.0", - "remark-rehype": "^11.0.0", - "source-map": "^0.7.0", - "unified": "^11.0.0", - "unist-util-position-from-estree": "^2.0.0", - "unist-util-stringify-position": "^4.0.0", - "unist-util-visit": "^5.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/@mdx-js/react": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz", - "integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==", - "license": "MIT", - "dependencies": { - "@types/mdx": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - }, - "peerDependencies": { - "@types/react": ">=16", - "react": ">=16" - } - }, - "node_modules/@napi-rs/wasm-runtime": { - "version": "0.2.12", - "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-0.2.12.tgz", - "integrity": "sha512-ZVWUcfwY4E/yPitQJl481FjFo3K22D6qF0DuFH6Y/nbnE11GY5uguDxZMGXPQ8WQ0128MXQD7TnfHyK4oWoIJQ==", - "license": "MIT", - "optional": true, - "dependencies": { - "@emnapi/core": "^1.4.3", - "@emnapi/runtime": "^1.4.3", - "@tybys/wasm-util": "^0.10.0" - } - }, - "node_modules/@noble/hashes": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/@noble/hashes/-/hashes-1.4.0.tgz", - "integrity": "sha512-V1JJ1WTRUqHHrOSh597hURcMqVKVGL/ea3kv0gSnEdsEZ0/+VyPghM1lMNGc00z7CIQorSvbKpuJkxvuHbvdbg==", - "license": "MIT", - "engines": { - "node": ">= 16" - }, - "funding": { - "url": "https://paulmillr.com/funding/" - } - }, - "node_modules/@node-rs/jieba": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba/-/jieba-1.10.4.tgz", - "integrity": "sha512-GvDgi8MnBiyWd6tksojej8anIx18244NmIOc1ovEw8WKNUejcccLfyu8vj66LWSuoZuKILVtNsOy4jvg3aoxIw==", - "license": "MIT", - "engines": { - "node": ">= 10" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/Brooooooklyn" - }, - "optionalDependencies": { - "@node-rs/jieba-android-arm-eabi": "1.10.4", - "@node-rs/jieba-android-arm64": "1.10.4", - "@node-rs/jieba-darwin-arm64": "1.10.4", - "@node-rs/jieba-darwin-x64": "1.10.4", - "@node-rs/jieba-freebsd-x64": "1.10.4", - "@node-rs/jieba-linux-arm-gnueabihf": "1.10.4", - "@node-rs/jieba-linux-arm64-gnu": "1.10.4", - "@node-rs/jieba-linux-arm64-musl": "1.10.4", - "@node-rs/jieba-linux-x64-gnu": "1.10.4", - "@node-rs/jieba-linux-x64-musl": "1.10.4", - "@node-rs/jieba-wasm32-wasi": "1.10.4", - "@node-rs/jieba-win32-arm64-msvc": "1.10.4", - "@node-rs/jieba-win32-ia32-msvc": "1.10.4", - "@node-rs/jieba-win32-x64-msvc": "1.10.4" - } - }, - "node_modules/@node-rs/jieba-android-arm-eabi": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-android-arm-eabi/-/jieba-android-arm-eabi-1.10.4.tgz", - "integrity": "sha512-MhyvW5N3Fwcp385d0rxbCWH42kqDBatQTyP8XbnYbju2+0BO/eTeCCLYj7Agws4pwxn2LtdldXRSKavT7WdzNA==", - "cpu": [ - "arm" - ], - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-android-arm64": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-android-arm64/-/jieba-android-arm64-1.10.4.tgz", - "integrity": "sha512-XyDwq5+rQ+Tk55A+FGi6PtJbzf974oqnpyCcCPzwU3QVXJCa2Rr4Lci+fx8oOpU4plT3GuD+chXMYLsXipMgJA==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-darwin-arm64": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-darwin-arm64/-/jieba-darwin-arm64-1.10.4.tgz", - "integrity": "sha512-G++RYEJ2jo0rxF9626KUy90wp06TRUjAsvY/BrIzEOX/ingQYV/HjwQzNPRR1P1o32a6/U8RGo7zEBhfdybL6w==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-darwin-x64": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-darwin-x64/-/jieba-darwin-x64-1.10.4.tgz", - "integrity": "sha512-MmDNeOb2TXIZCPyWCi2upQnZpPjAxw5ZGEj6R8kNsPXVFALHIKMa6ZZ15LCOkSTsKXVC17j2t4h+hSuyYb6qfQ==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-freebsd-x64": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-freebsd-x64/-/jieba-freebsd-x64-1.10.4.tgz", - "integrity": "sha512-/x7aVQ8nqUWhpXU92RZqd333cq639i/olNpd9Z5hdlyyV5/B65LLy+Je2B2bfs62PVVm5QXRpeBcZqaHelp/bg==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-linux-arm-gnueabihf": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm-gnueabihf/-/jieba-linux-arm-gnueabihf-1.10.4.tgz", - "integrity": "sha512-crd2M35oJBRLkoESs0O6QO3BBbhpv+tqXuKsqhIG94B1d02RVxtRIvSDwO33QurxqSdvN9IeSnVpHbDGkuXm3g==", - "cpu": [ - "arm" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-linux-arm64-gnu": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm64-gnu/-/jieba-linux-arm64-gnu-1.10.4.tgz", - "integrity": "sha512-omIzNX1psUzPcsdnUhGU6oHeOaTCuCjUgOA/v/DGkvWC1jLcnfXe4vdYbtXMh4XOCuIgS1UCcvZEc8vQLXFbXQ==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-linux-arm64-musl": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm64-musl/-/jieba-linux-arm64-musl-1.10.4.tgz", - "integrity": "sha512-Y/tiJ1+HeS5nnmLbZOE+66LbsPOHZ/PUckAYVeLlQfpygLEpLYdlh0aPpS5uiaWMjAXYZYdFkpZHhxDmSLpwpw==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-linux-x64-gnu": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-x64-gnu/-/jieba-linux-x64-gnu-1.10.4.tgz", - "integrity": "sha512-WZO8ykRJpWGE9MHuZpy1lu3nJluPoeB+fIJJn5CWZ9YTVhNDWoCF4i/7nxz1ntulINYGQ8VVuCU9LD86Mek97g==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-linux-x64-musl": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-x64-musl/-/jieba-linux-x64-musl-1.10.4.tgz", - "integrity": "sha512-uBBD4S1rGKcgCyAk6VCKatEVQb6EDD5I40v/DxODi5CuZVCANi9m5oee/MQbAoaX7RydA2f0OSCE9/tcwXEwUg==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-wasm32-wasi": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-wasm32-wasi/-/jieba-wasm32-wasi-1.10.4.tgz", - "integrity": "sha512-Y2umiKHjuIJy0uulNDz9SDYHdfq5Hmy7jY5nORO99B4pySKkcrMjpeVrmWXJLIsEKLJwcCXHxz8tjwU5/uhz0A==", - "cpu": [ - "wasm32" - ], - "license": "MIT", - "optional": true, - "dependencies": { - "@napi-rs/wasm-runtime": "^0.2.3" - }, - "engines": { - "node": ">=14.0.0" - } - }, - "node_modules/@node-rs/jieba-win32-arm64-msvc": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-arm64-msvc/-/jieba-win32-arm64-msvc-1.10.4.tgz", - "integrity": "sha512-nwMtViFm4hjqhz1it/juQnxpXgqlGltCuWJ02bw70YUDMDlbyTy3grCJPpQQpueeETcALUnTxda8pZuVrLRcBA==", - "cpu": [ - "arm64" - ], - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-win32-ia32-msvc": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-ia32-msvc/-/jieba-win32-ia32-msvc-1.10.4.tgz", - "integrity": "sha512-DCAvLx7Z+W4z5oKS+7vUowAJr0uw9JBw8x1Y23Xs/xMA4Em+OOSiaF5/tCJqZUCJ8uC4QeImmgDFiBqGNwxlyA==", - "cpu": [ - "ia32" - ], - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@node-rs/jieba-win32-x64-msvc": { - "version": "1.10.4", - "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-x64-msvc/-/jieba-win32-x64-msvc-1.10.4.tgz", - "integrity": "sha512-+sqemSfS1jjb+Tt7InNbNzrRh1Ua3vProVvC4BZRPg010/leCbGFFiQHpzcPRfpxAXZrzG5Y0YBTsPzN/I4yHQ==", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">= 10" - } - }, - "node_modules/@nodelib/fs.scandir": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "2.0.5", - "run-parallel": "^1.1.9" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.stat": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/@nodelib/fs.walk": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", - "license": "MIT", - "dependencies": { - "@nodelib/fs.scandir": "2.1.5", - "fastq": "^1.6.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/@peculiar/asn1-cms": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-cms/-/asn1-cms-2.6.1.tgz", - "integrity": "sha512-vdG4fBF6Lkirkcl53q6eOdn3XYKt+kJTG59edgRZORlg/3atWWEReRCx5rYE1ZzTTX6vLK5zDMjHh7vbrcXGtw==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-schema": "^2.6.0", - "@peculiar/asn1-x509": "^2.6.1", - "@peculiar/asn1-x509-attr": "^2.6.1", - "asn1js": "^3.0.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-csr": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-csr/-/asn1-csr-2.6.1.tgz", - "integrity": "sha512-WRWnKfIocHyzFYQTka8O/tXCiBquAPSrRjXbOkHbO4qdmS6loffCEGs+rby6WxxGdJCuunnhS2duHURhjyio6w==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-schema": "^2.6.0", - "@peculiar/asn1-x509": "^2.6.1", - "asn1js": "^3.0.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-ecc": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-ecc/-/asn1-ecc-2.6.1.tgz", - "integrity": "sha512-+Vqw8WFxrtDIN5ehUdvlN2m73exS2JVG0UAyfVB31gIfor3zWEAQPD+K9ydCxaj3MLen9k0JhKpu9LqviuCE1g==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-schema": "^2.6.0", - "@peculiar/asn1-x509": "^2.6.1", - "asn1js": "^3.0.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-pfx": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-pfx/-/asn1-pfx-2.6.1.tgz", - "integrity": "sha512-nB5jVQy3MAAWvq0KY0R2JUZG8bO/bTLpnwyOzXyEh/e54ynGTatAR+csOnXkkVD9AFZ2uL8Z7EV918+qB1qDvw==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-cms": "^2.6.1", - "@peculiar/asn1-pkcs8": "^2.6.1", - "@peculiar/asn1-rsa": "^2.6.1", - "@peculiar/asn1-schema": "^2.6.0", - "asn1js": "^3.0.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-pkcs8": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-pkcs8/-/asn1-pkcs8-2.6.1.tgz", - "integrity": "sha512-JB5iQ9Izn5yGMw3ZG4Nw3Xn/hb/G38GYF3lf7WmJb8JZUydhVGEjK/ZlFSWhnlB7K/4oqEs8HnfFIKklhR58Tw==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-schema": "^2.6.0", - "@peculiar/asn1-x509": "^2.6.1", - "asn1js": "^3.0.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-pkcs9": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-pkcs9/-/asn1-pkcs9-2.6.1.tgz", - "integrity": "sha512-5EV8nZoMSxeWmcxWmmcolg22ojZRgJg+Y9MX2fnE2bGRo5KQLqV5IL9kdSQDZxlHz95tHvIq9F//bvL1OeNILw==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-cms": "^2.6.1", - "@peculiar/asn1-pfx": "^2.6.1", - "@peculiar/asn1-pkcs8": "^2.6.1", - "@peculiar/asn1-schema": "^2.6.0", - "@peculiar/asn1-x509": "^2.6.1", - "@peculiar/asn1-x509-attr": "^2.6.1", - "asn1js": "^3.0.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-rsa": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-rsa/-/asn1-rsa-2.6.1.tgz", - "integrity": "sha512-1nVMEh46SElUt5CB3RUTV4EG/z7iYc7EoaDY5ECwganibQPkZ/Y2eMsTKB/LeyrUJ+W/tKoD9WUqIy8vB+CEdA==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-schema": "^2.6.0", - "@peculiar/asn1-x509": "^2.6.1", - "asn1js": "^3.0.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-schema": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-schema/-/asn1-schema-2.6.0.tgz", - "integrity": "sha512-xNLYLBFTBKkCzEZIw842BxytQQATQv+lDTCEMZ8C196iJcJJMBUZxrhSTxLaohMyKK8QlzRNTRkUmanucnDSqg==", - "license": "MIT", - "dependencies": { - "asn1js": "^3.0.6", - "pvtsutils": "^1.3.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-x509": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-x509/-/asn1-x509-2.6.1.tgz", - "integrity": "sha512-O9jT5F1A2+t3r7C4VT7LYGXqkGLK7Kj1xFpz7U0isPrubwU5PbDoyYtx6MiGst29yq7pXN5vZbQFKRCP+lLZlA==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-schema": "^2.6.0", - "asn1js": "^3.0.6", - "pvtsutils": "^1.3.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/asn1-x509-attr": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/@peculiar/asn1-x509-attr/-/asn1-x509-attr-2.6.1.tgz", - "integrity": "sha512-tlW6cxoHwgcQghnJwv3YS+9OO1737zgPogZ+CgWRUK4roEwIPzRH4JEiG770xe5HX2ATfCpmX60gurfWIF9dcQ==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-schema": "^2.6.0", - "@peculiar/asn1-x509": "^2.6.1", - "asn1js": "^3.0.6", - "tslib": "^2.8.1" - } - }, - "node_modules/@peculiar/x509": { - "version": "1.14.3", - "resolved": "https://registry.npmjs.org/@peculiar/x509/-/x509-1.14.3.tgz", - "integrity": "sha512-C2Xj8FZ0uHWeCXXqX5B4/gVFQmtSkiuOolzAgutjTfseNOHT3pUjljDZsTSxXFGgio54bCzVFqmEOUrIVk8RDA==", - "license": "MIT", - "dependencies": { - "@peculiar/asn1-cms": "^2.6.0", - "@peculiar/asn1-csr": "^2.6.0", - "@peculiar/asn1-ecc": "^2.6.0", - "@peculiar/asn1-pkcs9": "^2.6.0", - "@peculiar/asn1-rsa": "^2.6.0", - "@peculiar/asn1-schema": "^2.6.0", - "@peculiar/asn1-x509": "^2.6.0", - "pvtsutils": "^1.3.6", - "reflect-metadata": "^0.2.2", - "tslib": "^2.8.1", - "tsyringe": "^4.10.0" - }, - "engines": { - "node": ">=20.0.0" - } - }, - "node_modules/@pnpm/config.env-replace": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz", - "integrity": "sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w==", - "license": "MIT", - "engines": { - "node": ">=12.22.0" - } - }, - "node_modules/@pnpm/network.ca-file": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.2.tgz", - "integrity": "sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA==", - "license": "MIT", - "dependencies": { - "graceful-fs": "4.2.10" - }, - "engines": { - "node": ">=12.22.0" - } - }, - "node_modules/@pnpm/network.ca-file/node_modules/graceful-fs": { - "version": "4.2.10", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", - "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", - "license": "ISC" - }, - "node_modules/@pnpm/npm-conf": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-3.0.2.tgz", - "integrity": "sha512-h104Kh26rR8tm+a3Qkc5S4VLYint3FE48as7+/5oCEcKR2idC/pF1G6AhIXKI+eHPJa/3J9i5z0Al47IeGHPkA==", - "license": "MIT", - "dependencies": { - "@pnpm/config.env-replace": "^1.1.0", - "@pnpm/network.ca-file": "^1.0.1", - "config-chain": "^1.1.11" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/@polka/url": { - "version": "1.0.0-next.29", - "resolved": "https://registry.npmjs.org/@polka/url/-/url-1.0.0-next.29.tgz", - "integrity": "sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww==", - "license": "MIT" - }, - "node_modules/@shikijs/engine-oniguruma": { - "version": "3.23.0", - "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz", - "integrity": "sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@shikijs/types": "3.23.0", - "@shikijs/vscode-textmate": "^10.0.2" - } - }, - "node_modules/@shikijs/langs": { - "version": "3.23.0", - "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.23.0.tgz", - "integrity": "sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@shikijs/types": "3.23.0" - } - }, - "node_modules/@shikijs/themes": { - "version": "3.23.0", - "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.23.0.tgz", - "integrity": "sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@shikijs/types": "3.23.0" - } - }, - "node_modules/@shikijs/types": { - "version": "3.23.0", - "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.23.0.tgz", - "integrity": "sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@shikijs/vscode-textmate": "^10.0.2", - "@types/hast": "^3.0.4" - } - }, - "node_modules/@shikijs/vscode-textmate": { - "version": "10.0.2", - "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", - "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", - "dev": true, - "license": "MIT" - }, - "node_modules/@sideway/address": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz", - "integrity": "sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q==", - "license": "BSD-3-Clause", - "dependencies": { - "@hapi/hoek": "^9.0.0" - } - }, - "node_modules/@sideway/formula": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/@sideway/formula/-/formula-3.0.1.tgz", - "integrity": "sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg==", - "license": "BSD-3-Clause" - }, - "node_modules/@sideway/pinpoint": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@sideway/pinpoint/-/pinpoint-2.0.0.tgz", - "integrity": "sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ==", - "license": "BSD-3-Clause" - }, - "node_modules/@sinclair/typebox": { - "version": "0.27.10", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.10.tgz", - "integrity": "sha512-MTBk/3jGLNB2tVxv6uLlFh1iu64iYOQ2PbdOSK3NW8JZsmlaOh2q6sdtKowBhfw8QFLmYNzTW4/oK4uATIi6ZA==", - "license": "MIT" - }, - "node_modules/@sindresorhus/is": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", - "integrity": "sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/is?sponsor=1" - } - }, - "node_modules/@slorber/remark-comment": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@slorber/remark-comment/-/remark-comment-1.0.0.tgz", - "integrity": "sha512-RCE24n7jsOj1M0UPvIQCHTe7fI0sFL4S2nwKVWwHyVr/wI/H8GosgsJGyhnsZoGFnD/P2hLf1mSbrrgSLN93NA==", - "license": "MIT", - "dependencies": { - "micromark-factory-space": "^1.0.0", - "micromark-util-character": "^1.1.0", - "micromark-util-symbol": "^1.0.1" - } - }, - "node_modules/@svgr/babel-plugin-add-jsx-attribute": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz", - "integrity": "sha512-b9MIk7yhdS1pMCZM8VeNfUlSKVRhsHZNMl5O9SfaX0l0t5wjdgu4IDzGB8bpnGBBOjGST3rRFVsaaEtI4W6f7g==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-remove-jsx-attribute": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-attribute/-/babel-plugin-remove-jsx-attribute-8.0.0.tgz", - "integrity": "sha512-BcCkm/STipKvbCl6b7QFrMh/vx00vIP63k2eM66MfHJzPr6O2U0jYEViXkHJWqXqQYjdeA9cuCl5KWmlwjDvbA==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-remove-jsx-empty-expression": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-empty-expression/-/babel-plugin-remove-jsx-empty-expression-8.0.0.tgz", - "integrity": "sha512-5BcGCBfBxB5+XSDSWnhTThfI9jcO5f0Ai2V24gZpG+wXF14BzwxxdDb4g6trdOux0rhibGs385BeFMSmxtS3uA==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-replace-jsx-attribute-value": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-replace-jsx-attribute-value/-/babel-plugin-replace-jsx-attribute-value-8.0.0.tgz", - "integrity": "sha512-KVQ+PtIjb1BuYT3ht8M5KbzWBhdAjjUPdlMtpuw/VjT8coTrItWX6Qafl9+ji831JaJcu6PJNKCV0bp01lBNzQ==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-svg-dynamic-title": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-dynamic-title/-/babel-plugin-svg-dynamic-title-8.0.0.tgz", - "integrity": "sha512-omNiKqwjNmOQJ2v6ge4SErBbkooV2aAWwaPFs2vUY7p7GhVkzRkJ00kILXQvRhA6miHnNpXv7MRnnSjdRjK8og==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-svg-em-dimensions": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-em-dimensions/-/babel-plugin-svg-em-dimensions-8.0.0.tgz", - "integrity": "sha512-mURHYnu6Iw3UBTbhGwE/vsngtCIbHE43xCRK7kCw4t01xyGqb2Pd+WXekRRoFOBIY29ZoOhUCTEweDMdrjfi9g==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-transform-react-native-svg": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-react-native-svg/-/babel-plugin-transform-react-native-svg-8.1.0.tgz", - "integrity": "sha512-Tx8T58CHo+7nwJ+EhUwx3LfdNSG9R2OKfaIXXs5soiy5HtgoAEkDay9LIimLOcG8dJQH1wPZp/cnAv6S9CrR1Q==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-transform-svg-component": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-svg-component/-/babel-plugin-transform-svg-component-8.0.0.tgz", - "integrity": "sha512-DFx8xa3cZXTdb/k3kfPeaixecQLgKh5NVBMwD0AQxOzcZawK4oo1Jh9LbrcACUivsCA7TLG8eeWgrDXjTMhRmw==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-preset": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-preset/-/babel-preset-8.1.0.tgz", - "integrity": "sha512-7EYDbHE7MxHpv4sxvnVPngw5fuR6pw79SkcrILHJ/iMpuKySNCl5W1qcwPEpU+LgyRXOaAFgH0KhwD18wwg6ug==", - "license": "MIT", - "dependencies": { - "@svgr/babel-plugin-add-jsx-attribute": "8.0.0", - "@svgr/babel-plugin-remove-jsx-attribute": "8.0.0", - "@svgr/babel-plugin-remove-jsx-empty-expression": "8.0.0", - "@svgr/babel-plugin-replace-jsx-attribute-value": "8.0.0", - "@svgr/babel-plugin-svg-dynamic-title": "8.0.0", - "@svgr/babel-plugin-svg-em-dimensions": "8.0.0", - "@svgr/babel-plugin-transform-react-native-svg": "8.1.0", - "@svgr/babel-plugin-transform-svg-component": "8.0.0" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/core": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", - "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", - "license": "MIT", - "dependencies": { - "@babel/core": "^7.21.3", - "@svgr/babel-preset": "8.1.0", - "camelcase": "^6.2.0", - "cosmiconfig": "^8.1.3", - "snake-case": "^3.0.4" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - } - }, - "node_modules/@svgr/hast-util-to-babel-ast": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/hast-util-to-babel-ast/-/hast-util-to-babel-ast-8.0.0.tgz", - "integrity": "sha512-EbDKwO9GpfWP4jN9sGdYwPBU0kdomaPIL2Eu4YwmgP+sJeXT+L7bMwJUBnhzfH8Q2qMBqZ4fJwpCyYsAN3mt2Q==", - "license": "MIT", - "dependencies": { - "@babel/types": "^7.21.3", - "entities": "^4.4.0" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - } - }, - "node_modules/@svgr/plugin-jsx": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/plugin-jsx/-/plugin-jsx-8.1.0.tgz", - "integrity": "sha512-0xiIyBsLlr8quN+WyuxooNW9RJ0Dpr8uOnH/xrCVO8GLUcwHISwj1AG0k+LFzteTkAA0GbX0kj9q6Dk70PTiPA==", - "license": "MIT", - "dependencies": { - "@babel/core": "^7.21.3", - "@svgr/babel-preset": "8.1.0", - "@svgr/hast-util-to-babel-ast": "8.0.0", - "svg-parser": "^2.0.4" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@svgr/core": "*" - } - }, - "node_modules/@svgr/plugin-svgo": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/plugin-svgo/-/plugin-svgo-8.1.0.tgz", - "integrity": "sha512-Ywtl837OGO9pTLIN/onoWLmDQ4zFUycI1g76vuKGEz6evR/ZTJlJuz3G/fIkb6OVBJ2g0o6CGJzaEjfmEo3AHA==", - "license": "MIT", - "dependencies": { - "cosmiconfig": "^8.1.3", - "deepmerge": "^4.3.1", - "svgo": "^3.0.2" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@svgr/core": "*" - } - }, - "node_modules/@svgr/webpack": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/webpack/-/webpack-8.1.0.tgz", - "integrity": "sha512-LnhVjMWyMQV9ZmeEy26maJk+8HTIbd59cH4F2MJ439k9DqejRisfFNGAPvRYlKETuh9LrImlS8aKsBgKjMA8WA==", - "license": "MIT", - "dependencies": { - "@babel/core": "^7.21.3", - "@babel/plugin-transform-react-constant-elements": "^7.21.3", - "@babel/preset-env": "^7.20.2", - "@babel/preset-react": "^7.18.6", - "@babel/preset-typescript": "^7.21.0", - "@svgr/core": "8.1.0", - "@svgr/plugin-jsx": "8.1.0", - "@svgr/plugin-svgo": "8.1.0" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - } - }, - "node_modules/@szmarczak/http-timer": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-5.0.1.tgz", - "integrity": "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==", - "license": "MIT", - "dependencies": { - "defer-to-connect": "^2.0.1" - }, - "engines": { - "node": ">=14.16" - } - }, - "node_modules/@tybys/wasm-util": { - "version": "0.10.1", - "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.1.tgz", - "integrity": "sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg==", - "license": "MIT", - "optional": true, - "dependencies": { - "tslib": "^2.4.0" - } - }, - "node_modules/@types/body-parser": { - "version": "1.19.6", - "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.6.tgz", - "integrity": "sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g==", - "license": "MIT", - "dependencies": { - "@types/connect": "*", - "@types/node": "*" - } - }, - "node_modules/@types/bonjour": { - "version": "3.5.13", - "resolved": "https://registry.npmjs.org/@types/bonjour/-/bonjour-3.5.13.tgz", - "integrity": "sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/connect": { - "version": "3.4.38", - "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", - "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/connect-history-api-fallback": { - "version": "1.5.4", - "resolved": "https://registry.npmjs.org/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz", - "integrity": "sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw==", - "license": "MIT", - "dependencies": { - "@types/express-serve-static-core": "*", - "@types/node": "*" - } - }, - "node_modules/@types/debug": { - "version": "4.1.13", - "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.13.tgz", - "integrity": "sha512-KSVgmQmzMwPlmtljOomayoR89W4FynCAi3E8PPs7vmDVPe84hT+vGPKkJfThkmXs0x0jAaa9U8uW8bbfyS2fWw==", - "license": "MIT", - "dependencies": { - "@types/ms": "*" - } - }, - "node_modules/@types/eslint": { - "version": "9.6.1", - "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-9.6.1.tgz", - "integrity": "sha512-FXx2pKgId/WyYo2jXw63kk7/+TY7u7AziEJxJAnSFzHlqTAS3Ync6SvgYAN/k4/PQpnnVuzoMuVnByKK2qp0ag==", - "license": "MIT", - "dependencies": { - "@types/estree": "*", - "@types/json-schema": "*" - } - }, - "node_modules/@types/eslint-scope": { - "version": "3.7.7", - "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.7.tgz", - "integrity": "sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg==", - "license": "MIT", - "dependencies": { - "@types/eslint": "*", - "@types/estree": "*" - } - }, - "node_modules/@types/estree": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", - "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", - "license": "MIT" - }, - "node_modules/@types/estree-jsx": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/@types/estree-jsx/-/estree-jsx-1.0.5.tgz", - "integrity": "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg==", - "license": "MIT", - "dependencies": { - "@types/estree": "*" - } - }, - "node_modules/@types/express": { - "version": "4.17.25", - "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.25.tgz", - "integrity": "sha512-dVd04UKsfpINUnK0yBoYHDF3xu7xVH4BuDotC/xGuycx4CgbP48X/KF/586bcObxT0HENHXEU8Nqtu6NR+eKhw==", - "license": "MIT", - "dependencies": { - "@types/body-parser": "*", - "@types/express-serve-static-core": "^4.17.33", - "@types/qs": "*", - "@types/serve-static": "^1" - } - }, - "node_modules/@types/express-serve-static-core": { - "version": "4.19.8", - "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.8.tgz", - "integrity": "sha512-02S5fmqeoKzVZCHPZid4b8JH2eM5HzQLZWN2FohQEy/0eXTq8VXZfSN6Pcr3F6N9R/vNrj7cpgbhjie6m/1tCA==", - "license": "MIT", - "dependencies": { - "@types/node": "*", - "@types/qs": "*", - "@types/range-parser": "*", - "@types/send": "*" - } - }, - "node_modules/@types/gtag.js": { - "version": "0.0.12", - "resolved": "https://registry.npmjs.org/@types/gtag.js/-/gtag.js-0.0.12.tgz", - "integrity": "sha512-YQV9bUsemkzG81Ea295/nF/5GijnD2Af7QhEofh7xu+kvCN6RdodgNwwGWXB5GMI3NoyvQo0odNctoH/qLMIpg==", - "license": "MIT" - }, - "node_modules/@types/hast": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", - "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", - "license": "MIT", - "dependencies": { - "@types/unist": "*" - } - }, - "node_modules/@types/history": { - "version": "4.7.11", - "resolved": "https://registry.npmjs.org/@types/history/-/history-4.7.11.tgz", - "integrity": "sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA==", - "license": "MIT" - }, - "node_modules/@types/html-minifier-terser": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", - "integrity": "sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg==", - "license": "MIT" - }, - "node_modules/@types/http-cache-semantics": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", - "integrity": "sha512-L3LgimLHXtGkWikKnsPg0/VFx9OGZaC+eN1u4r+OB1XRqH3meBIAVC2zr1WdMH+RHmnRkqliQAOHNJ/E0j/e0Q==", - "license": "MIT" - }, - "node_modules/@types/http-errors": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.5.tgz", - "integrity": "sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg==", - "license": "MIT" - }, - "node_modules/@types/http-proxy": { - "version": "1.17.17", - "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.17.tgz", - "integrity": "sha512-ED6LB+Z1AVylNTu7hdzuBqOgMnvG/ld6wGCG8wFnAzKX5uyW2K3WD52v0gnLCTK/VLpXtKckgWuyScYK6cSPaw==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/istanbul-lib-coverage": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", - "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", - "license": "MIT" - }, - "node_modules/@types/istanbul-lib-report": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", - "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", - "license": "MIT", - "dependencies": { - "@types/istanbul-lib-coverage": "*" - } - }, - "node_modules/@types/istanbul-reports": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", - "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", - "license": "MIT", - "dependencies": { - "@types/istanbul-lib-report": "*" - } - }, - "node_modules/@types/json-schema": { - "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", - "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "license": "MIT" - }, - "node_modules/@types/mdast": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", - "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", - "license": "MIT", - "dependencies": { - "@types/unist": "*" - } - }, - "node_modules/@types/mdx": { - "version": "2.0.13", - "resolved": "https://registry.npmjs.org/@types/mdx/-/mdx-2.0.13.tgz", - "integrity": "sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw==", - "license": "MIT" - }, - "node_modules/@types/mime": { - "version": "1.3.5", - "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", - "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==", - "license": "MIT" - }, - "node_modules/@types/ms": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz", - "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==", - "license": "MIT" - }, - "node_modules/@types/node": { - "version": "25.5.0", - "resolved": "https://registry.npmjs.org/@types/node/-/node-25.5.0.tgz", - "integrity": "sha512-jp2P3tQMSxWugkCUKLRPVUpGaL5MVFwF8RDuSRztfwgN1wmqJeMSbKlnEtQqU8UrhTmzEmZdu2I6v2dpp7XIxw==", - "license": "MIT", - "dependencies": { - "undici-types": "~7.18.0" - } - }, - "node_modules/@types/prismjs": { - "version": "1.26.6", - "resolved": "https://registry.npmjs.org/@types/prismjs/-/prismjs-1.26.6.tgz", - "integrity": "sha512-vqlvI7qlMvcCBbVe0AKAb4f97//Hy0EBTaiW8AalRnG/xAN5zOiWWyrNqNXeq8+KAuvRewjCVY1+IPxk4RdNYw==", - "license": "MIT" - }, - "node_modules/@types/qs": { - "version": "6.15.0", - "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.15.0.tgz", - "integrity": "sha512-JawvT8iBVWpzTrz3EGw9BTQFg3BQNmwERdKE22vlTxawwtbyUSlMppvZYKLZzB5zgACXdXxbD3m1bXaMqP/9ow==", - "license": "MIT" - }, - "node_modules/@types/range-parser": { - "version": "1.2.7", - "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz", - "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", - "license": "MIT" - }, - "node_modules/@types/react": { - "version": "19.2.14", - "resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.14.tgz", - "integrity": "sha512-ilcTH/UniCkMdtexkoCN0bI7pMcJDvmQFPvuPvmEaYA/NSfFTAgdUSLAoVjaRJm7+6PvcM+q1zYOwS4wTYMF9w==", - "license": "MIT", - "dependencies": { - "csstype": "^3.2.2" - } - }, - "node_modules/@types/react-router": { - "version": "5.1.20", - "resolved": "https://registry.npmjs.org/@types/react-router/-/react-router-5.1.20.tgz", - "integrity": "sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q==", - "license": "MIT", - "dependencies": { - "@types/history": "^4.7.11", - "@types/react": "*" - } - }, - "node_modules/@types/react-router-config": { - "version": "5.0.11", - "resolved": "https://registry.npmjs.org/@types/react-router-config/-/react-router-config-5.0.11.tgz", - "integrity": "sha512-WmSAg7WgqW7m4x8Mt4N6ZyKz0BubSj/2tVUMsAHp+Yd2AMwcSbeFq9WympT19p5heCFmF97R9eD5uUR/t4HEqw==", - "license": "MIT", - "dependencies": { - "@types/history": "^4.7.11", - "@types/react": "*", - "@types/react-router": "^5.1.0" - } - }, - "node_modules/@types/react-router-dom": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/@types/react-router-dom/-/react-router-dom-5.3.3.tgz", - "integrity": "sha512-kpqnYK4wcdm5UaWI3fLcELopqLrHgLqNsdpHauzlQktfkHL3npOSwtj1Uz9oKBAzs7lFtVkV8j83voAz2D8fhw==", - "license": "MIT", - "dependencies": { - "@types/history": "^4.7.11", - "@types/react": "*", - "@types/react-router": "*" - } - }, - "node_modules/@types/retry": { - "version": "0.12.2", - "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.2.tgz", - "integrity": "sha512-XISRgDJ2Tc5q4TRqvgJtzsRkFYNJzZrhTdtMoGVBttwzzQJkPnS3WWTFc7kuDRoPtPakl+T+OfdEUjYJj7Jbow==", - "license": "MIT" - }, - "node_modules/@types/sax": { - "version": "1.2.7", - "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.7.tgz", - "integrity": "sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/send": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@types/send/-/send-1.2.1.tgz", - "integrity": "sha512-arsCikDvlU99zl1g69TcAB3mzZPpxgw0UQnaHeC1Nwb015xp8bknZv5rIfri9xTOcMuaVgvabfIRA7PSZVuZIQ==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/serve-index": { - "version": "1.9.4", - "resolved": "https://registry.npmjs.org/@types/serve-index/-/serve-index-1.9.4.tgz", - "integrity": "sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug==", - "license": "MIT", - "dependencies": { - "@types/express": "*" - } - }, - "node_modules/@types/serve-static": { - "version": "1.15.10", - "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.10.tgz", - "integrity": "sha512-tRs1dB+g8Itk72rlSI2ZrW6vZg0YrLI81iQSTkMmOqnqCaNr/8Ek4VwWcN5vZgCYWbg/JJSGBlUaYGAOP73qBw==", - "license": "MIT", - "dependencies": { - "@types/http-errors": "*", - "@types/node": "*", - "@types/send": "<1" - } - }, - "node_modules/@types/serve-static/node_modules/@types/send": { - "version": "0.17.6", - "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.6.tgz", - "integrity": "sha512-Uqt8rPBE8SY0RK8JB1EzVOIZ32uqy8HwdxCnoCOsYrvnswqmFZ/k+9Ikidlk/ImhsdvBsloHbAlewb2IEBV/Og==", - "license": "MIT", - "dependencies": { - "@types/mime": "^1", - "@types/node": "*" - } - }, - "node_modules/@types/sockjs": { - "version": "0.3.36", - "resolved": "https://registry.npmjs.org/@types/sockjs/-/sockjs-0.3.36.tgz", - "integrity": "sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/unist": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", - "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", - "license": "MIT" - }, - "node_modules/@types/ws": { - "version": "8.18.1", - "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz", - "integrity": "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/yargs": { - "version": "17.0.35", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.35.tgz", - "integrity": "sha512-qUHkeCyQFxMXg79wQfTtfndEC+N9ZZg76HJftDJp+qH2tV7Gj4OJi7l+PiWwJ+pWtW8GwSmqsDj/oymhrTWXjg==", - "license": "MIT", - "dependencies": { - "@types/yargs-parser": "*" - } - }, - "node_modules/@types/yargs-parser": { - "version": "21.0.3", - "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", - "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", - "license": "MIT" - }, - "node_modules/@ungap/structured-clone": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", - "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", - "license": "ISC" - }, - "node_modules/@webassemblyjs/ast": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.14.1.tgz", - "integrity": "sha512-nuBEDgQfm1ccRp/8bCQrx1frohyufl4JlbMMZ4P1wpeOfDhF6FQkxZJ1b/e+PLwr6X1Nhw6OLme5usuBWYBvuQ==", - "license": "MIT", - "dependencies": { - "@webassemblyjs/helper-numbers": "1.13.2", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2" - } - }, - "node_modules/@webassemblyjs/floating-point-hex-parser": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.13.2.tgz", - "integrity": "sha512-6oXyTOzbKxGH4steLbLNOu71Oj+C8Lg34n6CqRvqfS2O71BxY6ByfMDRhBytzknj9yGUPVJ1qIKhRlAwO1AovA==", - "license": "MIT" - }, - "node_modules/@webassemblyjs/helper-api-error": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.13.2.tgz", - "integrity": "sha512-U56GMYxy4ZQCbDZd6JuvvNV/WFildOjsaWD3Tzzvmw/mas3cXzRJPMjP83JqEsgSbyrmaGjBfDtV7KDXV9UzFQ==", - "license": "MIT" - }, - "node_modules/@webassemblyjs/helper-buffer": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.14.1.tgz", - "integrity": "sha512-jyH7wtcHiKssDtFPRB+iQdxlDf96m0E39yb0k5uJVhFGleZFoNw1c4aeIcVUPPbXUVJ94wwnMOAqUHyzoEPVMA==", - "license": "MIT" - }, - "node_modules/@webassemblyjs/helper-numbers": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.13.2.tgz", - "integrity": "sha512-FE8aCmS5Q6eQYcV3gI35O4J789wlQA+7JrqTTpJqn5emA4U2hvwJmvFRC0HODS+3Ye6WioDklgd6scJ3+PLnEA==", - "license": "MIT", - "dependencies": { - "@webassemblyjs/floating-point-hex-parser": "1.13.2", - "@webassemblyjs/helper-api-error": "1.13.2", - "@xtuc/long": "4.2.2" - } - }, - "node_modules/@webassemblyjs/helper-wasm-bytecode": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.13.2.tgz", - "integrity": "sha512-3QbLKy93F0EAIXLh0ogEVR6rOubA9AoZ+WRYhNbFyuB70j3dRdwH9g+qXhLAO0kiYGlg3TxDV+I4rQTr/YNXkA==", - "license": "MIT" - }, - "node_modules/@webassemblyjs/helper-wasm-section": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.14.1.tgz", - "integrity": "sha512-ds5mXEqTJ6oxRoqjhWDU83OgzAYjwsCV8Lo/N+oRsNDmx/ZDpqalmrtgOMkHwxsG0iI//3BwWAErYRHtgn0dZw==", - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-buffer": "1.14.1", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2", - "@webassemblyjs/wasm-gen": "1.14.1" - } - }, - "node_modules/@webassemblyjs/ieee754": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.13.2.tgz", - "integrity": "sha512-4LtOzh58S/5lX4ITKxnAK2USuNEvpdVV9AlgGQb8rJDHaLeHciwG4zlGr0j/SNWlr7x3vO1lDEsuePvtcDNCkw==", - "license": "MIT", - "dependencies": { - "@xtuc/ieee754": "^1.2.0" - } - }, - "node_modules/@webassemblyjs/leb128": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.13.2.tgz", - "integrity": "sha512-Lde1oNoIdzVzdkNEAWZ1dZ5orIbff80YPdHx20mrHwHrVNNTjNr8E3xz9BdpcGqRQbAEa+fkrCb+fRFTl/6sQw==", - "license": "Apache-2.0", - "dependencies": { - "@xtuc/long": "4.2.2" - } - }, - "node_modules/@webassemblyjs/utf8": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.13.2.tgz", - "integrity": "sha512-3NQWGjKTASY1xV5m7Hr0iPeXD9+RDobLll3T9d2AO+g3my8xy5peVyjSag4I50mR1bBSN/Ct12lo+R9tJk0NZQ==", - "license": "MIT" - }, - "node_modules/@webassemblyjs/wasm-edit": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.14.1.tgz", - "integrity": "sha512-RNJUIQH/J8iA/1NzlE4N7KtyZNHi3w7at7hDjvRNm5rcUXa00z1vRz3glZoULfJ5mpvYhLybmVcwcjGrC1pRrQ==", - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-buffer": "1.14.1", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2", - "@webassemblyjs/helper-wasm-section": "1.14.1", - "@webassemblyjs/wasm-gen": "1.14.1", - "@webassemblyjs/wasm-opt": "1.14.1", - "@webassemblyjs/wasm-parser": "1.14.1", - "@webassemblyjs/wast-printer": "1.14.1" - } - }, - "node_modules/@webassemblyjs/wasm-gen": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.14.1.tgz", - "integrity": "sha512-AmomSIjP8ZbfGQhumkNvgC33AY7qtMCXnN6bL2u2Js4gVCg8fp735aEiMSBbDR7UQIj90n4wKAFUSEd0QN2Ukg==", - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2", - "@webassemblyjs/ieee754": "1.13.2", - "@webassemblyjs/leb128": "1.13.2", - "@webassemblyjs/utf8": "1.13.2" - } - }, - "node_modules/@webassemblyjs/wasm-opt": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.14.1.tgz", - "integrity": "sha512-PTcKLUNvBqnY2U6E5bdOQcSM+oVP/PmrDY9NzowJjislEjwP/C4an2303MCVS2Mg9d3AJpIGdUFIQQWbPds0Sw==", - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-buffer": "1.14.1", - "@webassemblyjs/wasm-gen": "1.14.1", - "@webassemblyjs/wasm-parser": "1.14.1" - } - }, - "node_modules/@webassemblyjs/wasm-parser": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.14.1.tgz", - "integrity": "sha512-JLBl+KZ0R5qB7mCnud/yyX08jWFw5MsoalJ1pQ4EdFlgj9VdXKGuENGsiCIjegI1W7p91rUlcB/LB5yRJKNTcQ==", - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-api-error": "1.13.2", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2", - "@webassemblyjs/ieee754": "1.13.2", - "@webassemblyjs/leb128": "1.13.2", - "@webassemblyjs/utf8": "1.13.2" - } - }, - "node_modules/@webassemblyjs/wast-printer": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.14.1.tgz", - "integrity": "sha512-kPSSXE6De1XOR820C90RIo2ogvZG+c3KiHzqUoO/F34Y2shGzesfqv7o57xrxovZJH/MetF5UjroJ/R/3isoiw==", - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@xtuc/long": "4.2.2" - } - }, - "node_modules/@xtuc/ieee754": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", - "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==", - "license": "BSD-3-Clause" - }, - "node_modules/@xtuc/long": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", - "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==", - "license": "Apache-2.0" - }, - "node_modules/accepts": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", - "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", - "license": "MIT", - "dependencies": { - "mime-types": "~2.1.34", - "negotiator": "0.6.3" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/accepts/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/accepts/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/accepts/node_modules/negotiator": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", - "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/acorn": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", - "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", - "license": "MIT", - "bin": { - "acorn": "bin/acorn" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/acorn-import-phases": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz", - "integrity": "sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ==", - "license": "MIT", - "engines": { - "node": ">=10.13.0" - }, - "peerDependencies": { - "acorn": "^8.14.0" - } - }, - "node_modules/acorn-jsx": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", - "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", - "license": "MIT", - "peerDependencies": { - "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" - } - }, - "node_modules/acorn-walk": { - "version": "8.3.5", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.5.tgz", - "integrity": "sha512-HEHNfbars9v4pgpW6SO1KSPkfoS0xVOM/9UzkJltjlsHZmJasxg8aXkuZa7SMf8vKGIBhpUsPluQSqhJFCqebw==", - "license": "MIT", - "dependencies": { - "acorn": "^8.11.0" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/address": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/address/-/address-1.2.2.tgz", - "integrity": "sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA==", - "license": "MIT", - "engines": { - "node": ">= 10.0.0" - } - }, - "node_modules/aggregate-error": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", - "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", - "license": "MIT", - "dependencies": { - "clean-stack": "^2.0.0", - "indent-string": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/ajv": { - "version": "8.18.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", - "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.3", - "fast-uri": "^3.0.1", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/ajv-formats": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz", - "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==", - "license": "MIT", - "dependencies": { - "ajv": "^8.0.0" - }, - "peerDependencies": { - "ajv": "^8.0.0" - }, - "peerDependenciesMeta": { - "ajv": { - "optional": true - } - } - }, - "node_modules/ajv-keywords": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-5.1.0.tgz", - "integrity": "sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==", - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.3" - }, - "peerDependencies": { - "ajv": "^8.8.2" - } - }, - "node_modules/algoliasearch": { - "version": "5.50.0", - "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.50.0.tgz", - "integrity": "sha512-yE5I83Q2s8euVou8Y3feXK08wyZInJWLYXgWO6Xti9jBUEZAGUahyeQ7wSZWkifLWVnQVKEz5RAmBlXG5nqxog==", - "license": "MIT", - "dependencies": { - "@algolia/abtesting": "1.16.0", - "@algolia/client-abtesting": "5.50.0", - "@algolia/client-analytics": "5.50.0", - "@algolia/client-common": "5.50.0", - "@algolia/client-insights": "5.50.0", - "@algolia/client-personalization": "5.50.0", - "@algolia/client-query-suggestions": "5.50.0", - "@algolia/client-search": "5.50.0", - "@algolia/ingestion": "1.50.0", - "@algolia/monitoring": "1.50.0", - "@algolia/recommend": "5.50.0", - "@algolia/requester-browser-xhr": "5.50.0", - "@algolia/requester-fetch": "5.50.0", - "@algolia/requester-node-http": "5.50.0" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/algoliasearch-helper": { - "version": "3.28.1", - "resolved": "https://registry.npmjs.org/algoliasearch-helper/-/algoliasearch-helper-3.28.1.tgz", - "integrity": "sha512-6iXpbkkrAI5HFpCWXlNmIDSBuoN/U1XnEvb2yJAoWfqrZ+DrybI7MQ5P5mthFaprmocq+zbi6HxnR28xnZAYBw==", - "license": "MIT", - "dependencies": { - "@algolia/events": "^4.0.1" - }, - "peerDependencies": { - "algoliasearch": ">= 3.1 < 6" - } - }, - "node_modules/ansi-align": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", - "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", - "license": "ISC", - "dependencies": { - "string-width": "^4.1.0" - } - }, - "node_modules/ansi-align/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "license": "MIT" - }, - "node_modules/ansi-align/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "license": "MIT", - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/ansi-escapes": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", - "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", - "license": "MIT", - "dependencies": { - "type-fest": "^0.21.3" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/ansi-escapes/node_modules/type-fest": { - "version": "0.21.3", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", - "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/ansi-html-community": { - "version": "0.0.8", - "resolved": "https://registry.npmjs.org/ansi-html-community/-/ansi-html-community-0.0.8.tgz", - "integrity": "sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw==", - "engines": [ - "node >= 0.8.0" - ], - "license": "Apache-2.0", - "bin": { - "ansi-html": "bin/ansi-html" - } - }, - "node_modules/ansi-regex": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "license": "MIT", - "dependencies": { - "color-convert": "^2.0.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/anymatch": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", - "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", - "license": "ISC", - "dependencies": { - "normalize-path": "^3.0.0", - "picomatch": "^2.0.4" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/arg": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", - "integrity": "sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==", - "license": "MIT" - }, - "node_modules/argparse": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "license": "Python-2.0" - }, - "node_modules/array-flatten": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", - "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", - "license": "MIT" - }, - "node_modules/array-union": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", - "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/asn1js": { - "version": "3.0.7", - "resolved": "https://registry.npmjs.org/asn1js/-/asn1js-3.0.7.tgz", - "integrity": "sha512-uLvq6KJu04qoQM6gvBfKFjlh6Gl0vOKQuR5cJMDHQkmwfMOQeN3F3SHCv9SNYSL+CRoHvOGFfllDlVz03GQjvQ==", - "license": "BSD-3-Clause", - "dependencies": { - "pvtsutils": "^1.3.6", - "pvutils": "^1.1.3", - "tslib": "^2.8.1" - }, - "engines": { - "node": ">=12.0.0" - } - }, - "node_modules/astring": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/astring/-/astring-1.9.0.tgz", - "integrity": "sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg==", - "license": "MIT", - "bin": { - "astring": "bin/astring" - } - }, - "node_modules/autoprefixer": { - "version": "10.4.27", - "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.27.tgz", - "integrity": "sha512-NP9APE+tO+LuJGn7/9+cohklunJsXWiaWEfV3si4Gi/XHDwVNgkwr1J3RQYFIvPy76GmJ9/bW8vyoU1LcxwKHA==", - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/autoprefixer" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "MIT", - "dependencies": { - "browserslist": "^4.28.1", - "caniuse-lite": "^1.0.30001774", - "fraction.js": "^5.3.4", - "picocolors": "^1.1.1", - "postcss-value-parser": "^4.2.0" - }, - "bin": { - "autoprefixer": "bin/autoprefixer" - }, - "engines": { - "node": "^10 || ^12 || >=14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/babel-loader": { - "version": "9.2.1", - "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-9.2.1.tgz", - "integrity": "sha512-fqe8naHt46e0yIdkjUZYqddSXfej3AHajX+CSO5X7oy0EmPc6o5Xh+RClNoHjnieWz9AW4kZxW9yyFMhVB1QLA==", - "license": "MIT", - "dependencies": { - "find-cache-dir": "^4.0.0", - "schema-utils": "^4.0.0" - }, - "engines": { - "node": ">= 14.15.0" - }, - "peerDependencies": { - "@babel/core": "^7.12.0", - "webpack": ">=5" - } - }, - "node_modules/babel-plugin-dynamic-import-node": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/babel-plugin-dynamic-import-node/-/babel-plugin-dynamic-import-node-2.3.3.tgz", - "integrity": "sha512-jZVI+s9Zg3IqA/kdi0i6UDCybUI3aSBLnglhYbSSjKlV7yF1F/5LWv8MakQmvYpnbJDS6fcBL2KzHSxNCMtWSQ==", - "license": "MIT", - "dependencies": { - "object.assign": "^4.1.0" - } - }, - "node_modules/babel-plugin-polyfill-corejs2": { - "version": "0.4.17", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.17.tgz", - "integrity": "sha512-aTyf30K/rqAsNwN76zYrdtx8obu0E4KoUME29B1xj+B3WxgvWkp943vYQ+z8Mv3lw9xHXMHpvSPOBxzAkIa94w==", - "license": "MIT", - "dependencies": { - "@babel/compat-data": "^7.28.6", - "@babel/helper-define-polyfill-provider": "^0.6.8", - "semver": "^6.3.1" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/babel-plugin-polyfill-corejs2/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/babel-plugin-polyfill-corejs3": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz", - "integrity": "sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A==", - "license": "MIT", - "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.5", - "core-js-compat": "^3.43.0" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/babel-plugin-polyfill-regenerator": { - "version": "0.6.8", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.8.tgz", - "integrity": "sha512-M762rNHfSF1EV3SLtnCJXFoQbbIIz0OyRwnCmV0KPC7qosSfCO0QLTSuJX3ayAebubhE6oYBAYPrBA5ljowaZg==", - "license": "MIT", - "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.8" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/bail": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/bail/-/bail-2.0.2.tgz", - "integrity": "sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "license": "MIT" - }, - "node_modules/baseline-browser-mapping": { - "version": "2.10.11", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.11.tgz", - "integrity": "sha512-DAKrHphkJyiGuau/cFieRYhcTFeK/lBuD++C7cZ6KZHbMhBrisoi+EvhQ5RZrIfV5qwsW8kgQ07JIC+MDJRAhg==", - "license": "Apache-2.0", - "bin": { - "baseline-browser-mapping": "dist/cli.cjs" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/batch": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/batch/-/batch-0.6.1.tgz", - "integrity": "sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw==", - "license": "MIT" - }, - "node_modules/big.js": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", - "integrity": "sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==", - "license": "MIT", - "engines": { - "node": "*" - } - }, - "node_modules/binary-extensions": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", - "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/body-parser": { - "version": "1.20.4", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.4.tgz", - "integrity": "sha512-ZTgYYLMOXY9qKU/57FAo8F+HA2dGX7bqGc71txDRC1rS4frdFI5R7NhluHxH6M0YItAP0sHB4uqAOcYKxO6uGA==", - "license": "MIT", - "dependencies": { - "bytes": "~3.1.2", - "content-type": "~1.0.5", - "debug": "2.6.9", - "depd": "2.0.0", - "destroy": "~1.2.0", - "http-errors": "~2.0.1", - "iconv-lite": "~0.4.24", - "on-finished": "~2.4.1", - "qs": "~6.14.0", - "raw-body": "~2.5.3", - "type-is": "~1.6.18", - "unpipe": "~1.0.0" - }, - "engines": { - "node": ">= 0.8", - "npm": "1.2.8000 || >= 1.4.16" - } - }, - "node_modules/body-parser/node_modules/bytes": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", - "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/body-parser/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/body-parser/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "license": "MIT" - }, - "node_modules/bonjour-service": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/bonjour-service/-/bonjour-service-1.3.0.tgz", - "integrity": "sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA==", - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.3", - "multicast-dns": "^7.2.5" - } - }, - "node_modules/boolbase": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", - "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==", - "license": "ISC" - }, - "node_modules/boxen": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-6.2.1.tgz", - "integrity": "sha512-H4PEsJXfFI/Pt8sjDWbHlQPx4zL/bvSQjcilJmaulGt5mLDorHOHpmdXAJcBcmru7PhYSp/cDMWRko4ZUMFkSw==", - "license": "MIT", - "dependencies": { - "ansi-align": "^3.0.1", - "camelcase": "^6.2.0", - "chalk": "^4.1.2", - "cli-boxes": "^3.0.0", - "string-width": "^5.0.1", - "type-fest": "^2.5.0", - "widest-line": "^4.0.1", - "wrap-ansi": "^8.0.1" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", - "license": "MIT", - "dependencies": { - "fill-range": "^7.1.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/browserslist": { - "version": "4.28.1", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz", - "integrity": "sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA==", - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/browserslist" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "MIT", - "dependencies": { - "baseline-browser-mapping": "^2.9.0", - "caniuse-lite": "^1.0.30001759", - "electron-to-chromium": "^1.5.263", - "node-releases": "^2.0.27", - "update-browserslist-db": "^1.2.0" - }, - "bin": { - "browserslist": "cli.js" - }, - "engines": { - "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" - } - }, - "node_modules/buffer-from": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", - "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", - "license": "MIT" - }, - "node_modules/bundle-name": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/bundle-name/-/bundle-name-4.1.0.tgz", - "integrity": "sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q==", - "license": "MIT", - "dependencies": { - "run-applescript": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/bytes": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", - "integrity": "sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/bytestreamjs": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/bytestreamjs/-/bytestreamjs-2.0.1.tgz", - "integrity": "sha512-U1Z/ob71V/bXfVABvNr/Kumf5VyeQRBEm6Txb0PQ6S7V5GpBM3w4Cbqz/xPDicR5tN0uvDifng8C+5qECeGwyQ==", - "license": "BSD-3-Clause", - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/cacheable-lookup": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz", - "integrity": "sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w==", - "license": "MIT", - "engines": { - "node": ">=14.16" - } - }, - "node_modules/cacheable-request": { - "version": "10.2.14", - "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-10.2.14.tgz", - "integrity": "sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ==", - "license": "MIT", - "dependencies": { - "@types/http-cache-semantics": "^4.0.2", - "get-stream": "^6.0.1", - "http-cache-semantics": "^4.1.1", - "keyv": "^4.5.3", - "mimic-response": "^4.0.0", - "normalize-url": "^8.0.0", - "responselike": "^3.0.0" - }, - "engines": { - "node": ">=14.16" - } - }, - "node_modules/call-bind": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", - "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", - "license": "MIT", - "dependencies": { - "call-bind-apply-helpers": "^1.0.0", - "es-define-property": "^1.0.0", - "get-intrinsic": "^1.2.4", - "set-function-length": "^1.2.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/call-bind-apply-helpers": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", - "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", - "license": "MIT", - "dependencies": { - "es-errors": "^1.3.0", - "function-bind": "^1.1.2" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/call-bound": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", - "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", - "license": "MIT", - "dependencies": { - "call-bind-apply-helpers": "^1.0.2", - "get-intrinsic": "^1.3.0" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/callsites": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/camel-case": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", - "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", - "license": "MIT", - "dependencies": { - "pascal-case": "^3.1.2", - "tslib": "^2.0.3" - } - }, - "node_modules/camelcase": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", - "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/caniuse-api": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", - "integrity": "sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.0.0", - "caniuse-lite": "^1.0.0", - "lodash.memoize": "^4.1.2", - "lodash.uniq": "^4.5.0" - } - }, - "node_modules/caniuse-lite": { - "version": "1.0.30001781", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001781.tgz", - "integrity": "sha512-RdwNCyMsNBftLjW6w01z8bKEvT6e/5tpPVEgtn22TiLGlstHOVecsX2KHFkD5e/vRnIE4EGzpuIODb3mtswtkw==", - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/caniuse-lite" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "CC-BY-4.0" - }, - "node_modules/ccount": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", - "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/char-regex": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", - "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", - "license": "MIT", - "engines": { - "node": ">=10" - } - }, - "node_modules/character-entities": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", - "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/character-entities-html4": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", - "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/character-entities-legacy": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", - "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/character-reference-invalid": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz", - "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/cheerio": { - "version": "1.0.0-rc.12", - "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.12.tgz", - "integrity": "sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==", - "license": "MIT", - "dependencies": { - "cheerio-select": "^2.1.0", - "dom-serializer": "^2.0.0", - "domhandler": "^5.0.3", - "domutils": "^3.0.1", - "htmlparser2": "^8.0.1", - "parse5": "^7.0.0", - "parse5-htmlparser2-tree-adapter": "^7.0.0" - }, - "engines": { - "node": ">= 6" - }, - "funding": { - "url": "https://github.com/cheeriojs/cheerio?sponsor=1" - } - }, - "node_modules/cheerio-select": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz", - "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==", - "license": "BSD-2-Clause", - "dependencies": { - "boolbase": "^1.0.0", - "css-select": "^5.1.0", - "css-what": "^6.1.0", - "domelementtype": "^2.3.0", - "domhandler": "^5.0.3", - "domutils": "^3.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, - "node_modules/chokidar": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", - "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", - "license": "MIT", - "dependencies": { - "anymatch": "~3.1.2", - "braces": "~3.0.2", - "glob-parent": "~5.1.2", - "is-binary-path": "~2.1.0", - "is-glob": "~4.0.1", - "normalize-path": "~3.0.0", - "readdirp": "~3.6.0" - }, - "engines": { - "node": ">= 8.10.0" - }, - "funding": { - "url": "https://paulmillr.com/funding/" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" - } - }, - "node_modules/chrome-trace-event": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.4.tgz", - "integrity": "sha512-rNjApaLzuwaOTjCiT8lSDdGN1APCiqkChLMJxJPWLunPAt5fy8xgU9/jNOchV84wfIxrA0lRQB7oCT8jrn/wrQ==", - "license": "MIT", - "engines": { - "node": ">=6.0" - } - }, - "node_modules/ci-info": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", - "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/sibiraj-s" - } - ], - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/clean-css": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/clean-css/-/clean-css-5.3.3.tgz", - "integrity": "sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg==", - "license": "MIT", - "dependencies": { - "source-map": "~0.6.0" - }, - "engines": { - "node": ">= 10.0" - } - }, - "node_modules/clean-css/node_modules/source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "license": "BSD-3-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/clean-stack": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", - "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/cli-boxes": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", - "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/cli-table3": { - "version": "0.6.5", - "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.5.tgz", - "integrity": "sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ==", - "license": "MIT", - "dependencies": { - "string-width": "^4.2.0" - }, - "engines": { - "node": "10.* || >= 12.*" - }, - "optionalDependencies": { - "@colors/colors": "1.5.0" - } - }, - "node_modules/cli-table3/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "license": "MIT" - }, - "node_modules/cli-table3/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "license": "MIT", - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/clone-deep": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", - "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", - "license": "MIT", - "dependencies": { - "is-plain-object": "^2.0.4", - "kind-of": "^6.0.2", - "shallow-clone": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/clsx": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", - "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/collapse-white-space": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-2.1.0.tgz", - "integrity": "sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "license": "MIT", - "dependencies": { - "color-name": "~1.1.4" - }, - "engines": { - "node": ">=7.0.0" - } - }, - "node_modules/color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "license": "MIT" - }, - "node_modules/colord": { - "version": "2.9.3", - "resolved": "https://registry.npmjs.org/colord/-/colord-2.9.3.tgz", - "integrity": "sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==", - "license": "MIT" - }, - "node_modules/colorette": { - "version": "2.0.20", - "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", - "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==", - "license": "MIT" - }, - "node_modules/combine-promises": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/combine-promises/-/combine-promises-1.2.0.tgz", - "integrity": "sha512-VcQB1ziGD0NXrhKxiwyNbCDmRzs/OShMs2GqW2DlU2A/Sd0nQxE1oWDAE5O0ygSx5mgQOn9eIFh7yKPgFRVkPQ==", - "license": "MIT", - "engines": { - "node": ">=10" - } - }, - "node_modules/comlink": { - "version": "4.4.2", - "resolved": "https://registry.npmjs.org/comlink/-/comlink-4.4.2.tgz", - "integrity": "sha512-OxGdvBmJuNKSCMO4NTl1L47VRp6xn2wG4F/2hYzB6tiCb709otOxtEYCSvK80PtjODfXXZu8ds+Nw5kVCjqd2g==", - "license": "Apache-2.0" - }, - "node_modules/comma-separated-tokens": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", - "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/commander": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz", - "integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==", - "license": "MIT", - "engines": { - "node": ">= 6" - } - }, - "node_modules/common-path-prefix": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/common-path-prefix/-/common-path-prefix-3.0.0.tgz", - "integrity": "sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w==", - "license": "ISC" - }, - "node_modules/compressible": { - "version": "2.0.18", - "resolved": "https://registry.npmjs.org/compressible/-/compressible-2.0.18.tgz", - "integrity": "sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg==", - "license": "MIT", - "dependencies": { - "mime-db": ">= 1.43.0 < 2" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/compressible/node_modules/mime-db": { - "version": "1.54.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", - "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/compression": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/compression/-/compression-1.8.1.tgz", - "integrity": "sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w==", - "license": "MIT", - "dependencies": { - "bytes": "3.1.2", - "compressible": "~2.0.18", - "debug": "2.6.9", - "negotiator": "~0.6.4", - "on-headers": "~1.1.0", - "safe-buffer": "5.2.1", - "vary": "~1.1.2" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/compression/node_modules/bytes": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", - "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/compression/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/compression/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "license": "MIT" - }, - "node_modules/concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "license": "MIT" - }, - "node_modules/config-chain": { - "version": "1.1.13", - "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", - "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", - "license": "MIT", - "dependencies": { - "ini": "^1.3.4", - "proto-list": "~1.2.1" - } - }, - "node_modules/config-chain/node_modules/ini": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", - "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", - "license": "ISC" - }, - "node_modules/configstore": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", - "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", - "license": "BSD-2-Clause", - "dependencies": { - "dot-prop": "^6.0.1", - "graceful-fs": "^4.2.6", - "unique-string": "^3.0.0", - "write-file-atomic": "^3.0.3", - "xdg-basedir": "^5.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/yeoman/configstore?sponsor=1" - } - }, - "node_modules/connect-history-api-fallback": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/connect-history-api-fallback/-/connect-history-api-fallback-2.0.0.tgz", - "integrity": "sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA==", - "license": "MIT", - "engines": { - "node": ">=0.8" - } - }, - "node_modules/consola": { - "version": "3.4.2", - "resolved": "https://registry.npmjs.org/consola/-/consola-3.4.2.tgz", - "integrity": "sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA==", - "license": "MIT", - "engines": { - "node": "^14.18.0 || >=16.10.0" - } - }, - "node_modules/content-disposition": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.2.tgz", - "integrity": "sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/content-type": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", - "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/convert-source-map": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", - "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", - "license": "MIT" - }, - "node_modules/cookie": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", - "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/cookie-signature": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.7.tgz", - "integrity": "sha512-NXdYc3dLr47pBkpUCHtKSwIOQXLVn8dZEuywboCOJY/osA0wFSLlSawr3KN8qXJEyX66FcONTH8EIlVuK0yyFA==", - "license": "MIT" - }, - "node_modules/copy-webpack-plugin": { - "version": "11.0.0", - "resolved": "https://registry.npmjs.org/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz", - "integrity": "sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ==", - "license": "MIT", - "dependencies": { - "fast-glob": "^3.2.11", - "glob-parent": "^6.0.1", - "globby": "^13.1.1", - "normalize-path": "^3.0.0", - "schema-utils": "^4.0.0", - "serialize-javascript": "^6.0.0" - }, - "engines": { - "node": ">= 14.15.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.1.0" - } - }, - "node_modules/copy-webpack-plugin/node_modules/glob-parent": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", - "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.3" - }, - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/copy-webpack-plugin/node_modules/globby": { - "version": "13.2.2", - "resolved": "https://registry.npmjs.org/globby/-/globby-13.2.2.tgz", - "integrity": "sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==", - "license": "MIT", - "dependencies": { - "dir-glob": "^3.0.1", - "fast-glob": "^3.3.0", - "ignore": "^5.2.4", - "merge2": "^1.4.1", - "slash": "^4.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/copy-webpack-plugin/node_modules/slash": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", - "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/core-js": { - "version": "3.49.0", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.49.0.tgz", - "integrity": "sha512-es1U2+YTtzpwkxVLwAFdSpaIMyQaq0PBgm3YD1W3Qpsn1NAmO3KSgZfu+oGSWVu6NvLHoHCV/aYcsE5wiB7ALg==", - "hasInstallScript": true, - "license": "MIT", - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/core-js" - } - }, - "node_modules/core-js-compat": { - "version": "3.49.0", - "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.49.0.tgz", - "integrity": "sha512-VQXt1jr9cBz03b331DFDCCP90b3fanciLkgiOoy8SBHy06gNf+vQ1A3WFLqG7I8TipYIKeYK9wxd0tUrvHcOZA==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.28.1" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/core-js" - } - }, - "node_modules/core-js-pure": { - "version": "3.49.0", - "resolved": "https://registry.npmjs.org/core-js-pure/-/core-js-pure-3.49.0.tgz", - "integrity": "sha512-XM4RFka59xATyJv/cS3O3Kml72hQXUeGRuuTmMYFxwzc9/7C8OYTaIR/Ji+Yt8DXzsFLNhat15cE/JP15HrCgw==", - "hasInstallScript": true, - "license": "MIT", - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/core-js" - } - }, - "node_modules/core-util-is": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", - "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==", - "license": "MIT" - }, - "node_modules/cosmiconfig": { - "version": "8.3.6", - "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-8.3.6.tgz", - "integrity": "sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==", - "license": "MIT", - "dependencies": { - "import-fresh": "^3.3.0", - "js-yaml": "^4.1.0", - "parse-json": "^5.2.0", - "path-type": "^4.0.0" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/d-fischer" - }, - "peerDependencies": { - "typescript": ">=4.9.5" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } - } - }, - "node_modules/cross-spawn": { - "version": "7.0.6", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", - "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", - "license": "MIT", - "dependencies": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/crypto-random-string": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", - "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", - "license": "MIT", - "dependencies": { - "type-fest": "^1.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/crypto-random-string/node_modules/type-fest": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", - "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/css-blank-pseudo": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/css-blank-pseudo/-/css-blank-pseudo-7.0.1.tgz", - "integrity": "sha512-jf+twWGDf6LDoXDUode+nc7ZlrqfaNphrBIBrcmeP3D8yw1uPaix1gCC8LUQUGQ6CycuK2opkbFFWFuq/a94ag==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/css-blank-pseudo/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/css-declaration-sorter": { - "version": "7.3.1", - "resolved": "https://registry.npmjs.org/css-declaration-sorter/-/css-declaration-sorter-7.3.1.tgz", - "integrity": "sha512-gz6x+KkgNCjxq3Var03pRYLhyNfwhkKF1g/yoLgDNtFvVu0/fOLV9C8fFEZRjACp/XQLumjAYo7JVjzH3wLbxA==", - "license": "ISC", - "engines": { - "node": "^14 || ^16 || >=18" - }, - "peerDependencies": { - "postcss": "^8.0.9" - } - }, - "node_modules/css-has-pseudo": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/css-has-pseudo/-/css-has-pseudo-7.0.3.tgz", - "integrity": "sha512-oG+vKuGyqe/xvEMoxAQrhi7uY16deJR3i7wwhBerVrGQKSqUC5GiOVxTpM9F9B9hw0J+eKeOWLH7E9gZ1Dr5rA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/selector-specificity": "^5.0.0", - "postcss-selector-parser": "^7.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/css-has-pseudo/node_modules/@csstools/selector-specificity": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", - "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/css-has-pseudo/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/css-loader": { - "version": "6.11.0", - "resolved": "https://registry.npmjs.org/css-loader/-/css-loader-6.11.0.tgz", - "integrity": "sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g==", - "license": "MIT", - "dependencies": { - "icss-utils": "^5.1.0", - "postcss": "^8.4.33", - "postcss-modules-extract-imports": "^3.1.0", - "postcss-modules-local-by-default": "^4.0.5", - "postcss-modules-scope": "^3.2.0", - "postcss-modules-values": "^4.0.0", - "postcss-value-parser": "^4.2.0", - "semver": "^7.5.4" - }, - "engines": { - "node": ">= 12.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "@rspack/core": "0.x || 1.x", - "webpack": "^5.0.0" - }, - "peerDependenciesMeta": { - "@rspack/core": { - "optional": true - }, - "webpack": { - "optional": true - } - } - }, - "node_modules/css-minimizer-webpack-plugin": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/css-minimizer-webpack-plugin/-/css-minimizer-webpack-plugin-5.0.1.tgz", - "integrity": "sha512-3caImjKFQkS+ws1TGcFn0V1HyDJFq1Euy589JlD6/3rV2kj+w7r5G9WDMgSHvpvXHNZ2calVypZWuEDQd9wfLg==", - "license": "MIT", - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.18", - "cssnano": "^6.0.1", - "jest-worker": "^29.4.3", - "postcss": "^8.4.24", - "schema-utils": "^4.0.1", - "serialize-javascript": "^6.0.1" - }, - "engines": { - "node": ">= 14.15.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.0.0" - }, - "peerDependenciesMeta": { - "@parcel/css": { - "optional": true - }, - "@swc/css": { - "optional": true - }, - "clean-css": { - "optional": true - }, - "csso": { - "optional": true - }, - "esbuild": { - "optional": true - }, - "lightningcss": { - "optional": true - } - } - }, - "node_modules/css-prefers-color-scheme": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/css-prefers-color-scheme/-/css-prefers-color-scheme-10.0.0.tgz", - "integrity": "sha512-VCtXZAWivRglTZditUfB4StnsWr6YVZ2PRtuxQLKTNRdtAf8tpzaVPE9zXIF3VaSc7O70iK/j1+NXxyQCqdPjQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/css-select": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.2.2.tgz", - "integrity": "sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw==", - "license": "BSD-2-Clause", - "dependencies": { - "boolbase": "^1.0.0", - "css-what": "^6.1.0", - "domhandler": "^5.0.2", - "domutils": "^3.0.1", - "nth-check": "^2.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, - "node_modules/css-tree": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.3.1.tgz", - "integrity": "sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw==", - "license": "MIT", - "dependencies": { - "mdn-data": "2.0.30", - "source-map-js": "^1.0.1" - }, - "engines": { - "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0" - } - }, - "node_modules/css-what": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.2.2.tgz", - "integrity": "sha512-u/O3vwbptzhMs3L1fQE82ZSLHQQfto5gyZzwteVIEyeaY5Fc7R4dapF/BvRoSYFeqfBk4m0V1Vafq5Pjv25wvA==", - "license": "BSD-2-Clause", - "engines": { - "node": ">= 6" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, - "node_modules/cssdb": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/cssdb/-/cssdb-8.8.0.tgz", - "integrity": "sha512-QbLeyz2Bgso1iRlh7IpWk6OKa3lLNGXsujVjDMPl9rOZpxKeiG69icLpbLCFxeURwmcdIfZqQyhlooKJYM4f8Q==", - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - }, - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - } - ], - "license": "MIT-0" - }, - "node_modules/cssesc": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", - "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==", - "license": "MIT", - "bin": { - "cssesc": "bin/cssesc" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/cssnano": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/cssnano/-/cssnano-6.1.2.tgz", - "integrity": "sha512-rYk5UeX7VAM/u0lNqewCdasdtPK81CgX8wJFLEIXHbV2oldWRgJAsZrdhRXkV1NJzA2g850KiFm9mMU2HxNxMA==", - "license": "MIT", - "dependencies": { - "cssnano-preset-default": "^6.1.2", - "lilconfig": "^3.1.1" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/cssnano" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/cssnano-preset-advanced": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/cssnano-preset-advanced/-/cssnano-preset-advanced-6.1.2.tgz", - "integrity": "sha512-Nhao7eD8ph2DoHolEzQs5CfRpiEP0xa1HBdnFZ82kvqdmbwVBUr2r1QuQ4t1pi+D1ZpqpcO4T+wy/7RxzJ/WPQ==", - "license": "MIT", - "dependencies": { - "autoprefixer": "^10.4.19", - "browserslist": "^4.23.0", - "cssnano-preset-default": "^6.1.2", - "postcss-discard-unused": "^6.0.5", - "postcss-merge-idents": "^6.0.3", - "postcss-reduce-idents": "^6.0.3", - "postcss-zindex": "^6.0.2" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/cssnano-preset-default": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/cssnano-preset-default/-/cssnano-preset-default-6.1.2.tgz", - "integrity": "sha512-1C0C+eNaeN8OcHQa193aRgYexyJtU8XwbdieEjClw+J9d94E41LwT6ivKH0WT+fYwYWB0Zp3I3IZ7tI/BbUbrg==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "css-declaration-sorter": "^7.2.0", - "cssnano-utils": "^4.0.2", - "postcss-calc": "^9.0.1", - "postcss-colormin": "^6.1.0", - "postcss-convert-values": "^6.1.0", - "postcss-discard-comments": "^6.0.2", - "postcss-discard-duplicates": "^6.0.3", - "postcss-discard-empty": "^6.0.3", - "postcss-discard-overridden": "^6.0.2", - "postcss-merge-longhand": "^6.0.5", - "postcss-merge-rules": "^6.1.1", - "postcss-minify-font-values": "^6.1.0", - "postcss-minify-gradients": "^6.0.3", - "postcss-minify-params": "^6.1.0", - "postcss-minify-selectors": "^6.0.4", - "postcss-normalize-charset": "^6.0.2", - "postcss-normalize-display-values": "^6.0.2", - "postcss-normalize-positions": "^6.0.2", - "postcss-normalize-repeat-style": "^6.0.2", - "postcss-normalize-string": "^6.0.2", - "postcss-normalize-timing-functions": "^6.0.2", - "postcss-normalize-unicode": "^6.1.0", - "postcss-normalize-url": "^6.0.2", - "postcss-normalize-whitespace": "^6.0.2", - "postcss-ordered-values": "^6.0.2", - "postcss-reduce-initial": "^6.1.0", - "postcss-reduce-transforms": "^6.0.2", - "postcss-svgo": "^6.0.3", - "postcss-unique-selectors": "^6.0.4" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/cssnano-utils": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/cssnano-utils/-/cssnano-utils-4.0.2.tgz", - "integrity": "sha512-ZR1jHg+wZ8o4c3zqf1SIUSTIvm/9mU343FMR6Obe/unskbvpGhZOo1J6d/r8D1pzkRQYuwbcH3hToOuoA2G7oQ==", - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/csso": { - "version": "5.0.5", - "resolved": "https://registry.npmjs.org/csso/-/csso-5.0.5.tgz", - "integrity": "sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ==", - "license": "MIT", - "dependencies": { - "css-tree": "~2.2.0" - }, - "engines": { - "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", - "npm": ">=7.0.0" - } - }, - "node_modules/csso/node_modules/css-tree": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.2.1.tgz", - "integrity": "sha512-OA0mILzGc1kCOCSJerOeqDxDQ4HOh+G8NbOJFOTgOCzpw7fCBubk0fEyxp8AgOL/jvLgYA/uV0cMbe43ElF1JA==", - "license": "MIT", - "dependencies": { - "mdn-data": "2.0.28", - "source-map-js": "^1.0.1" - }, - "engines": { - "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", - "npm": ">=7.0.0" - } - }, - "node_modules/csso/node_modules/mdn-data": { - "version": "2.0.28", - "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.28.tgz", - "integrity": "sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g==", - "license": "CC0-1.0" - }, - "node_modules/csstype": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", - "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", - "license": "MIT" - }, - "node_modules/debounce": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/debounce/-/debounce-1.2.1.tgz", - "integrity": "sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug==", - "license": "MIT" - }, - "node_modules/debug": { - "version": "4.4.3", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", - "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", - "license": "MIT", - "dependencies": { - "ms": "^2.1.3" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } - }, - "node_modules/decode-named-character-reference": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.3.0.tgz", - "integrity": "sha512-GtpQYB283KrPp6nRw50q3U9/VfOutZOe103qlN7BPP6Ad27xYnOIWv4lPzo8HCAL+mMZofJ9KEy30fq6MfaK6Q==", - "license": "MIT", - "dependencies": { - "character-entities": "^2.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/decompress-response": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", - "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", - "license": "MIT", - "dependencies": { - "mimic-response": "^3.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/decompress-response/node_modules/mimic-response": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", - "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/deep-extend": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", - "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", - "license": "MIT", - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/deepmerge": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", - "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/default-browser": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/default-browser/-/default-browser-5.5.0.tgz", - "integrity": "sha512-H9LMLr5zwIbSxrmvikGuI/5KGhZ8E2zH3stkMgM5LpOWDutGM2JZaj460Udnf1a+946zc7YBgrqEWwbk7zHvGw==", - "license": "MIT", - "dependencies": { - "bundle-name": "^4.1.0", - "default-browser-id": "^5.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/default-browser-id": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/default-browser-id/-/default-browser-id-5.0.1.tgz", - "integrity": "sha512-x1VCxdX4t+8wVfd1so/9w+vQ4vx7lKd2Qp5tDRutErwmR85OgmfX7RlLRMWafRMY7hbEiXIbudNrjOAPa/hL8Q==", - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/defer-to-connect": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", - "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==", - "license": "MIT", - "engines": { - "node": ">=10" - } - }, - "node_modules/define-data-property": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", - "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", - "license": "MIT", - "dependencies": { - "es-define-property": "^1.0.0", - "es-errors": "^1.3.0", - "gopd": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/define-lazy-prop": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", - "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/define-properties": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", - "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", - "license": "MIT", - "dependencies": { - "define-data-property": "^1.0.1", - "has-property-descriptors": "^1.0.0", - "object-keys": "^1.1.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/depd": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", - "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/dequal": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", - "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/destroy": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", - "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", - "license": "MIT", - "engines": { - "node": ">= 0.8", - "npm": "1.2.8000 || >= 1.4.16" - } - }, - "node_modules/detect-node": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/detect-node/-/detect-node-2.1.0.tgz", - "integrity": "sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g==", - "license": "MIT" - }, - "node_modules/detect-port": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/detect-port/-/detect-port-1.6.1.tgz", - "integrity": "sha512-CmnVc+Hek2egPx1PeTFVta2W78xy2K/9Rkf6cC4T59S50tVnzKj+tnx5mmx5lwvCkujZ4uRrpRSuV+IVs3f90Q==", - "license": "MIT", - "dependencies": { - "address": "^1.0.1", - "debug": "4" - }, - "bin": { - "detect": "bin/detect-port.js", - "detect-port": "bin/detect-port.js" - }, - "engines": { - "node": ">= 4.0.0" - } - }, - "node_modules/devlop": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", - "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", - "license": "MIT", - "dependencies": { - "dequal": "^2.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/dir-glob": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", - "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", - "license": "MIT", - "dependencies": { - "path-type": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/dns-packet": { - "version": "5.6.1", - "resolved": "https://registry.npmjs.org/dns-packet/-/dns-packet-5.6.1.tgz", - "integrity": "sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw==", - "license": "MIT", - "dependencies": { - "@leichtgewicht/ip-codec": "^2.0.1" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/docusaurus-plugin-typedoc": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/docusaurus-plugin-typedoc/-/docusaurus-plugin-typedoc-1.4.2.tgz", - "integrity": "sha512-1qerRejLSYxEWdyVPLDMMeKFPLA/37yZAsdwJy9ThHFQR78+v3b5spSbk67VHGLr2mAn4FVHu0aGJ6p7iWotSg==", - "dev": true, - "license": "MIT", - "dependencies": { - "typedoc-docusaurus-theme": "^1.4.0" - }, - "peerDependencies": { - "typedoc-plugin-markdown": ">=4.8.0" - } - }, - "node_modules/dom-converter": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", - "integrity": "sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA==", - "license": "MIT", - "dependencies": { - "utila": "~0.4" - } - }, - "node_modules/dom-serializer": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", - "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", - "license": "MIT", - "dependencies": { - "domelementtype": "^2.3.0", - "domhandler": "^5.0.2", - "entities": "^4.2.0" - }, - "funding": { - "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" - } - }, - "node_modules/domelementtype": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", - "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ], - "license": "BSD-2-Clause" - }, - "node_modules/domhandler": { - "version": "5.0.3", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", - "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", - "license": "BSD-2-Clause", - "dependencies": { - "domelementtype": "^2.3.0" - }, - "engines": { - "node": ">= 4" - }, - "funding": { - "url": "https://github.com/fb55/domhandler?sponsor=1" - } - }, - "node_modules/domutils": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz", - "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==", - "license": "BSD-2-Clause", - "dependencies": { - "dom-serializer": "^2.0.0", - "domelementtype": "^2.3.0", - "domhandler": "^5.0.3" - }, - "funding": { - "url": "https://github.com/fb55/domutils?sponsor=1" - } - }, - "node_modules/dot-case": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", - "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", - "license": "MIT", - "dependencies": { - "no-case": "^3.0.4", - "tslib": "^2.0.3" - } - }, - "node_modules/dot-prop": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", - "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", - "license": "MIT", - "dependencies": { - "is-obj": "^2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/dot-prop/node_modules/is-obj": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", - "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/dunder-proto": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", - "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", - "license": "MIT", - "dependencies": { - "call-bind-apply-helpers": "^1.0.1", - "es-errors": "^1.3.0", - "gopd": "^1.2.0" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/duplexer": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", - "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", - "license": "MIT" - }, - "node_modules/eastasianwidth": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "license": "MIT" - }, - "node_modules/ee-first": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", - "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", - "license": "MIT" - }, - "node_modules/electron-to-chromium": { - "version": "1.5.325", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.325.tgz", - "integrity": "sha512-PwfIw7WQSt3xX7yOf5OE/unLzsK9CaN2f/FvV3WjPR1Knoc1T9vePRVV4W1EM301JzzysK51K7FNKcusCr0zYA==", - "license": "ISC" - }, - "node_modules/emoji-regex": { - "version": "9.2.2", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "license": "MIT" - }, - "node_modules/emojilib": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/emojilib/-/emojilib-2.4.0.tgz", - "integrity": "sha512-5U0rVMU5Y2n2+ykNLQqMoqklN9ICBT/KsvC1Gz6vqHbz2AXXGkG+Pm5rMWk/8Vjrr/mY9985Hi8DYzn1F09Nyw==", - "license": "MIT" - }, - "node_modules/emojis-list": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/emojis-list/-/emojis-list-3.0.0.tgz", - "integrity": "sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q==", - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/emoticon": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/emoticon/-/emoticon-4.1.0.tgz", - "integrity": "sha512-VWZfnxqwNcc51hIy/sbOdEem6D+cVtpPzEEtVAFdaas30+1dgkyaOQ4sQ6Bp0tOMqWO1v+HQfYaoodOkdhK6SQ==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/encodeurl": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz", - "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/encoding-sniffer": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/encoding-sniffer/-/encoding-sniffer-0.2.1.tgz", - "integrity": "sha512-5gvq20T6vfpekVtqrYQsSCFZ1wEg5+wW0/QaZMWkFr6BqD3NfKs0rLCx4rrVlSWJeZb5NBJgVLswK/w2MWU+Gw==", - "license": "MIT", - "dependencies": { - "iconv-lite": "^0.6.3", - "whatwg-encoding": "^3.1.1" - }, - "funding": { - "url": "https://github.com/fb55/encoding-sniffer?sponsor=1" - } - }, - "node_modules/encoding-sniffer/node_modules/iconv-lite": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", - "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/enhanced-resolve": { - "version": "5.20.1", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.20.1.tgz", - "integrity": "sha512-Qohcme7V1inbAfvjItgw0EaxVX5q2rdVEZHRBrEQdRZTssLDGsL8Lwrznl8oQ/6kuTJONLaDcGjkNP247XEhcA==", - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.2.4", - "tapable": "^2.3.0" - }, - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/entities": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", - "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", - "license": "BSD-2-Clause", - "engines": { - "node": ">=0.12" - }, - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, - "node_modules/error-ex": { - "version": "1.3.4", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.4.tgz", - "integrity": "sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ==", - "license": "MIT", - "dependencies": { - "is-arrayish": "^0.2.1" - } - }, - "node_modules/es-define-property": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", - "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/es-errors": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", - "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/es-module-lexer": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.0.0.tgz", - "integrity": "sha512-5POEcUuZybH7IdmGsD8wlf0AI55wMecM9rVBTI/qEAy2c1kTOm3DjFYjrBdI2K3BaJjJYfYFeRtM0t9ssnRuxw==", - "license": "MIT" - }, - "node_modules/es-object-atoms": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", - "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", - "license": "MIT", - "dependencies": { - "es-errors": "^1.3.0" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/esast-util-from-estree": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz", - "integrity": "sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ==", - "license": "MIT", - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "devlop": "^1.0.0", - "estree-util-visit": "^2.0.0", - "unist-util-position-from-estree": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/esast-util-from-js": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/esast-util-from-js/-/esast-util-from-js-2.0.1.tgz", - "integrity": "sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw==", - "license": "MIT", - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "acorn": "^8.0.0", - "esast-util-from-estree": "^2.0.0", - "vfile-message": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/escalade": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", - "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/escape-goat": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", - "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/escape-html": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", - "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", - "license": "MIT" - }, - "node_modules/escape-string-regexp": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", - "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/eslint-scope": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", - "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", - "license": "BSD-2-Clause", - "dependencies": { - "esrecurse": "^4.3.0", - "estraverse": "^4.1.1" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/esprima": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", - "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", - "license": "BSD-2-Clause", - "bin": { - "esparse": "bin/esparse.js", - "esvalidate": "bin/esvalidate.js" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/esrecurse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", - "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", - "license": "BSD-2-Clause", - "dependencies": { - "estraverse": "^5.2.0" - }, - "engines": { - "node": ">=4.0" - } - }, - "node_modules/esrecurse/node_modules/estraverse": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", - "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", - "license": "BSD-2-Clause", - "engines": { - "node": ">=4.0" - } - }, - "node_modules/estraverse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", - "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", - "license": "BSD-2-Clause", - "engines": { - "node": ">=4.0" - } - }, - "node_modules/estree-util-attach-comments": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz", - "integrity": "sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/estree-util-build-jsx": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/estree-util-build-jsx/-/estree-util-build-jsx-3.0.1.tgz", - "integrity": "sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ==", - "license": "MIT", - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "devlop": "^1.0.0", - "estree-util-is-identifier-name": "^3.0.0", - "estree-walker": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/estree-util-is-identifier-name": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz", - "integrity": "sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==", - "license": "MIT", - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/estree-util-scope": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/estree-util-scope/-/estree-util-scope-1.0.0.tgz", - "integrity": "sha512-2CAASclonf+JFWBNJPndcOpA8EMJwa0Q8LUFJEKqXLW6+qBvbFZuF5gItbQOs/umBUkjviCSDCbBwU2cXbmrhQ==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "devlop": "^1.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/estree-util-to-js": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/estree-util-to-js/-/estree-util-to-js-2.0.0.tgz", - "integrity": "sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg==", - "license": "MIT", - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "astring": "^1.8.0", - "source-map": "^0.7.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/estree-util-value-to-estree": { - "version": "3.5.0", - "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.5.0.tgz", - "integrity": "sha512-aMV56R27Gv3QmfmF1MY12GWkGzzeAezAX+UplqHVASfjc9wNzI/X6hC0S9oxq61WT4aQesLGslWP9tKk6ghRZQ==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/remcohaszing" - } - }, - "node_modules/estree-util-visit": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-2.0.0.tgz", - "integrity": "sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==", - "license": "MIT", - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "@types/unist": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/estree-walker": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", - "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0" - } - }, - "node_modules/esutils": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", - "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", - "license": "BSD-2-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/eta": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/eta/-/eta-2.2.0.tgz", - "integrity": "sha512-UVQ72Rqjy/ZKQalzV5dCCJP80GrmPrMxh6NlNf+erV6ObL0ZFkhCstWRawS85z3smdr3d2wXPsZEY7rDPfGd2g==", - "license": "MIT", - "engines": { - "node": ">=6.0.0" - }, - "funding": { - "url": "https://github.com/eta-dev/eta?sponsor=1" - } - }, - "node_modules/etag": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", - "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/eval": { - "version": "0.1.8", - "resolved": "https://registry.npmjs.org/eval/-/eval-0.1.8.tgz", - "integrity": "sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw==", - "dependencies": { - "@types/node": "*", - "require-like": ">= 0.1.1" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/eventemitter3": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", - "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", - "license": "MIT" - }, - "node_modules/events": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", - "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", - "license": "MIT", - "engines": { - "node": ">=0.8.x" - } - }, - "node_modules/execa": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", - "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", - "license": "MIT", - "dependencies": { - "cross-spawn": "^7.0.3", - "get-stream": "^6.0.0", - "human-signals": "^2.1.0", - "is-stream": "^2.0.0", - "merge-stream": "^2.0.0", - "npm-run-path": "^4.0.1", - "onetime": "^5.1.2", - "signal-exit": "^3.0.3", - "strip-final-newline": "^2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/execa?sponsor=1" - } - }, - "node_modules/express": { - "version": "4.22.1", - "resolved": "https://registry.npmjs.org/express/-/express-4.22.1.tgz", - "integrity": "sha512-F2X8g9P1X7uCPZMA3MVf9wcTqlyNp7IhH5qPCI0izhaOIYXaW9L535tGA3qmjRzpH+bZczqq7hVKxTR4NWnu+g==", - "license": "MIT", - "dependencies": { - "accepts": "~1.3.8", - "array-flatten": "1.1.1", - "body-parser": "~1.20.3", - "content-disposition": "~0.5.4", - "content-type": "~1.0.4", - "cookie": "~0.7.1", - "cookie-signature": "~1.0.6", - "debug": "2.6.9", - "depd": "2.0.0", - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "etag": "~1.8.1", - "finalhandler": "~1.3.1", - "fresh": "~0.5.2", - "http-errors": "~2.0.0", - "merge-descriptors": "1.0.3", - "methods": "~1.1.2", - "on-finished": "~2.4.1", - "parseurl": "~1.3.3", - "path-to-regexp": "~0.1.12", - "proxy-addr": "~2.0.7", - "qs": "~6.14.0", - "range-parser": "~1.2.1", - "safe-buffer": "5.2.1", - "send": "~0.19.0", - "serve-static": "~1.16.2", - "setprototypeof": "1.2.0", - "statuses": "~2.0.1", - "type-is": "~1.6.18", - "utils-merge": "1.0.1", - "vary": "~1.1.2" - }, - "engines": { - "node": ">= 0.10.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/express" - } - }, - "node_modules/express/node_modules/content-disposition": { - "version": "0.5.4", - "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", - "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", - "license": "MIT", - "dependencies": { - "safe-buffer": "5.2.1" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/express/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/express/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "license": "MIT" - }, - "node_modules/express/node_modules/path-to-regexp": { - "version": "0.1.13", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.13.tgz", - "integrity": "sha512-A/AGNMFN3c8bOlvV9RreMdrv7jsmF9XIfDeCd87+I8RNg6s78BhJxMu69NEMHBSJFxKidViTEdruRwEk/WIKqA==", - "license": "MIT" - }, - "node_modules/express/node_modules/range-parser": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", - "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/extend": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", - "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", - "license": "MIT" - }, - "node_modules/extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", - "license": "MIT", - "dependencies": { - "is-extendable": "^0.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "license": "MIT" - }, - "node_modules/fast-glob": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", - "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "^2.0.2", - "@nodelib/fs.walk": "^1.2.3", - "glob-parent": "^5.1.2", - "merge2": "^1.3.0", - "micromatch": "^4.0.8" - }, - "engines": { - "node": ">=8.6.0" - } - }, - "node_modules/fast-json-stable-stringify": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "license": "MIT" - }, - "node_modules/fast-uri": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", - "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/fastify" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/fastify" - } - ], - "license": "BSD-3-Clause" - }, - "node_modules/fastq": { - "version": "1.20.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", - "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", - "license": "ISC", - "dependencies": { - "reusify": "^1.0.4" - } - }, - "node_modules/fault": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/fault/-/fault-2.0.1.tgz", - "integrity": "sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ==", - "license": "MIT", - "dependencies": { - "format": "^0.2.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/faye-websocket": { - "version": "0.11.4", - "resolved": "https://registry.npmjs.org/faye-websocket/-/faye-websocket-0.11.4.tgz", - "integrity": "sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g==", - "license": "Apache-2.0", - "dependencies": { - "websocket-driver": ">=0.5.1" - }, - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/feed": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/feed/-/feed-4.2.2.tgz", - "integrity": "sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ==", - "license": "MIT", - "dependencies": { - "xml-js": "^1.6.11" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/figures": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", - "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", - "license": "MIT", - "dependencies": { - "escape-string-regexp": "^1.0.5" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/figures/node_modules/escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", - "license": "MIT", - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/file-loader": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/file-loader/-/file-loader-6.2.0.tgz", - "integrity": "sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw==", - "license": "MIT", - "dependencies": { - "loader-utils": "^2.0.0", - "schema-utils": "^3.0.0" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^4.0.0 || ^5.0.0" - } - }, - "node_modules/file-loader/node_modules/ajv": { - "version": "6.14.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", - "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/file-loader/node_modules/ajv-keywords": { - "version": "3.5.2", - "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", - "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", - "license": "MIT", - "peerDependencies": { - "ajv": "^6.9.1" - } - }, - "node_modules/file-loader/node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "license": "MIT" - }, - "node_modules/file-loader/node_modules/schema-utils": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", - "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", - "license": "MIT", - "dependencies": { - "@types/json-schema": "^7.0.8", - "ajv": "^6.12.5", - "ajv-keywords": "^3.5.2" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/fill-range": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", - "license": "MIT", - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/finalhandler": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.2.tgz", - "integrity": "sha512-aA4RyPcd3badbdABGDuTXCMTtOneUCAYH/gxoYRTZlIJdF0YPWuGqiAsIrhNnnqdXGswYk6dGujem4w80UJFhg==", - "license": "MIT", - "dependencies": { - "debug": "2.6.9", - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "on-finished": "~2.4.1", - "parseurl": "~1.3.3", - "statuses": "~2.0.2", - "unpipe": "~1.0.0" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/finalhandler/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/finalhandler/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "license": "MIT" - }, - "node_modules/find-cache-dir": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-4.0.0.tgz", - "integrity": "sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg==", - "license": "MIT", - "dependencies": { - "common-path-prefix": "^3.0.0", - "pkg-dir": "^7.0.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/find-up": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-6.3.0.tgz", - "integrity": "sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw==", - "license": "MIT", - "dependencies": { - "locate-path": "^7.1.0", - "path-exists": "^5.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/flat": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/flat/-/flat-5.0.2.tgz", - "integrity": "sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==", - "license": "BSD-3-Clause", - "bin": { - "flat": "cli.js" - } - }, - "node_modules/follow-redirects": { - "version": "1.15.11", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.11.tgz", - "integrity": "sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ==", - "funding": [ - { - "type": "individual", - "url": "https://github.com/sponsors/RubenVerborgh" - } - ], - "license": "MIT", - "engines": { - "node": ">=4.0" - }, - "peerDependenciesMeta": { - "debug": { - "optional": true - } - } - }, - "node_modules/form-data-encoder": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-2.1.4.tgz", - "integrity": "sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw==", - "license": "MIT", - "engines": { - "node": ">= 14.17" - } - }, - "node_modules/format": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz", - "integrity": "sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww==", - "engines": { - "node": ">=0.4.x" - } - }, - "node_modules/forwarded": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", - "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/fraction.js": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/fraction.js/-/fraction.js-5.3.4.tgz", - "integrity": "sha512-1X1NTtiJphryn/uLQz3whtY6jK3fTqoE3ohKs0tT+Ujr1W59oopxmoEh7Lu5p6vBaPbgoM0bzveAW4Qi5RyWDQ==", - "license": "MIT", - "engines": { - "node": "*" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/rawify" - } - }, - "node_modules/fresh": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", - "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/fs-extra": { - "version": "11.3.4", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.4.tgz", - "integrity": "sha512-CTXd6rk/M3/ULNQj8FBqBWHYBVYybQ3VPBw0xGKFe3tuH7ytT6ACnvzpIQ3UZtB8yvUKC2cXn1a+x+5EVQLovA==", - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" - }, - "engines": { - "node": ">=14.14" - } - }, - "node_modules/fsevents": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", - "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", - "hasInstallScript": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": "^8.16.0 || ^10.6.0 || >=11.0.0" - } - }, - "node_modules/function-bind": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", - "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/gensync": { - "version": "1.0.0-beta.2", - "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", - "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", - "license": "MIT", - "engines": { - "node": ">=6.9.0" - } - }, - "node_modules/get-intrinsic": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", - "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", - "license": "MIT", - "dependencies": { - "call-bind-apply-helpers": "^1.0.2", - "es-define-property": "^1.0.1", - "es-errors": "^1.3.0", - "es-object-atoms": "^1.1.1", - "function-bind": "^1.1.2", - "get-proto": "^1.0.1", - "gopd": "^1.2.0", - "has-symbols": "^1.1.0", - "hasown": "^2.0.2", - "math-intrinsics": "^1.1.0" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/get-own-enumerable-property-symbols": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz", - "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==", - "license": "ISC" - }, - "node_modules/get-proto": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", - "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", - "license": "MIT", - "dependencies": { - "dunder-proto": "^1.0.1", - "es-object-atoms": "^1.0.0" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/get-stream": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", - "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/github-slugger": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.5.0.tgz", - "integrity": "sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw==", - "license": "ISC" - }, - "node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/glob-to-regex.js": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/glob-to-regex.js/-/glob-to-regex.js-1.2.0.tgz", - "integrity": "sha512-QMwlOQKU/IzqMUOAZWubUOT8Qft+Y0KQWnX9nK3ch0CJg0tTp4TvGZsTfudYKv2NzoQSyPcnA6TYeIQ3jGichQ==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/glob-to-regexp": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", - "integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==", - "license": "BSD-2-Clause" - }, - "node_modules/global-dirs": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.1.tgz", - "integrity": "sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA==", - "license": "MIT", - "dependencies": { - "ini": "2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/globby": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", - "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", - "license": "MIT", - "dependencies": { - "array-union": "^2.1.0", - "dir-glob": "^3.0.1", - "fast-glob": "^3.2.9", - "ignore": "^5.2.0", - "merge2": "^1.4.1", - "slash": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/gopd": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", - "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/got": { - "version": "12.6.1", - "resolved": "https://registry.npmjs.org/got/-/got-12.6.1.tgz", - "integrity": "sha512-mThBblvlAF1d4O5oqyvN+ZxLAYwIJK7bpMxgYqPD9okW0C3qm5FFn7k811QrcuEBwaogR3ngOFoCfs6mRv7teQ==", - "license": "MIT", - "dependencies": { - "@sindresorhus/is": "^5.2.0", - "@szmarczak/http-timer": "^5.0.1", - "cacheable-lookup": "^7.0.0", - "cacheable-request": "^10.2.8", - "decompress-response": "^6.0.0", - "form-data-encoder": "^2.1.2", - "get-stream": "^6.0.1", - "http2-wrapper": "^2.1.10", - "lowercase-keys": "^3.0.0", - "p-cancelable": "^3.0.0", - "responselike": "^3.0.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sindresorhus/got?sponsor=1" - } - }, - "node_modules/got/node_modules/@sindresorhus/is": { - "version": "5.6.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-5.6.0.tgz", - "integrity": "sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g==", - "license": "MIT", - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sindresorhus/is?sponsor=1" - } - }, - "node_modules/graceful-fs": { - "version": "4.2.11", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", - "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", - "license": "ISC" - }, - "node_modules/gray-matter": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/gray-matter/-/gray-matter-4.0.3.tgz", - "integrity": "sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q==", - "license": "MIT", - "dependencies": { - "js-yaml": "^3.13.1", - "kind-of": "^6.0.2", - "section-matter": "^1.0.0", - "strip-bom-string": "^1.0.0" - }, - "engines": { - "node": ">=6.0" - } - }, - "node_modules/gray-matter/node_modules/argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "license": "MIT", - "dependencies": { - "sprintf-js": "~1.0.2" - } - }, - "node_modules/gray-matter/node_modules/js-yaml": { - "version": "3.14.2", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz", - "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==", - "license": "MIT", - "dependencies": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/gzip-size": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/gzip-size/-/gzip-size-6.0.0.tgz", - "integrity": "sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==", - "license": "MIT", - "dependencies": { - "duplexer": "^0.1.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/handle-thing": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/handle-thing/-/handle-thing-2.0.1.tgz", - "integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==", - "license": "MIT" - }, - "node_modules/has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/has-property-descriptors": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", - "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", - "license": "MIT", - "dependencies": { - "es-define-property": "^1.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/has-symbols": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", - "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/has-yarn": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", - "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/hasown": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", - "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", - "license": "MIT", - "dependencies": { - "function-bind": "^1.1.2" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/hast-util-from-parse5": { - "version": "8.0.3", - "resolved": "https://registry.npmjs.org/hast-util-from-parse5/-/hast-util-from-parse5-8.0.3.tgz", - "integrity": "sha512-3kxEVkEKt0zvcZ3hCRYI8rqrgwtlIOFMWkbclACvjlDw8Li9S2hk/d51OI0nr/gIpdMHNepwgOKqZ/sy0Clpyg==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0", - "@types/unist": "^3.0.0", - "devlop": "^1.0.0", - "hastscript": "^9.0.0", - "property-information": "^7.0.0", - "vfile": "^6.0.0", - "vfile-location": "^5.0.0", - "web-namespaces": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/hast-util-parse-selector": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz", - "integrity": "sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/hast-util-raw": { - "version": "9.1.0", - "resolved": "https://registry.npmjs.org/hast-util-raw/-/hast-util-raw-9.1.0.tgz", - "integrity": "sha512-Y8/SBAHkZGoNkpzqqfCldijcuUKh7/su31kEBp67cFY09Wy0mTRgtsLYsiIxMJxlu0f6AA5SUTbDR8K0rxnbUw==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0", - "@types/unist": "^3.0.0", - "@ungap/structured-clone": "^1.0.0", - "hast-util-from-parse5": "^8.0.0", - "hast-util-to-parse5": "^8.0.0", - "html-void-elements": "^3.0.0", - "mdast-util-to-hast": "^13.0.0", - "parse5": "^7.0.0", - "unist-util-position": "^5.0.0", - "unist-util-visit": "^5.0.0", - "vfile": "^6.0.0", - "web-namespaces": "^2.0.0", - "zwitch": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/hast-util-to-estree": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz", - "integrity": "sha512-48+B/rJWAp0jamNbAAf9M7Uf//UVqAoMmgXhBdxTDJLGKY+LRnZ99qcG+Qjl5HfMpYNzS5v4EAwVEF34LeAj7w==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "@types/estree-jsx": "^1.0.0", - "@types/hast": "^3.0.0", - "comma-separated-tokens": "^2.0.0", - "devlop": "^1.0.0", - "estree-util-attach-comments": "^3.0.0", - "estree-util-is-identifier-name": "^3.0.0", - "hast-util-whitespace": "^3.0.0", - "mdast-util-mdx-expression": "^2.0.0", - "mdast-util-mdx-jsx": "^3.0.0", - "mdast-util-mdxjs-esm": "^2.0.0", - "property-information": "^7.0.0", - "space-separated-tokens": "^2.0.0", - "style-to-js": "^1.0.0", - "unist-util-position": "^5.0.0", - "zwitch": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/hast-util-to-jsx-runtime": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz", - "integrity": "sha512-zl6s8LwNyo1P9uw+XJGvZtdFF1GdAkOg8ujOw+4Pyb76874fLps4ueHXDhXWdk6YHQ6OgUtinliG7RsYvCbbBg==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "@types/hast": "^3.0.0", - "@types/unist": "^3.0.0", - "comma-separated-tokens": "^2.0.0", - "devlop": "^1.0.0", - "estree-util-is-identifier-name": "^3.0.0", - "hast-util-whitespace": "^3.0.0", - "mdast-util-mdx-expression": "^2.0.0", - "mdast-util-mdx-jsx": "^3.0.0", - "mdast-util-mdxjs-esm": "^2.0.0", - "property-information": "^7.0.0", - "space-separated-tokens": "^2.0.0", - "style-to-js": "^1.0.0", - "unist-util-position": "^5.0.0", - "vfile-message": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/hast-util-to-parse5": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/hast-util-to-parse5/-/hast-util-to-parse5-8.0.1.tgz", - "integrity": "sha512-MlWT6Pjt4CG9lFCjiz4BH7l9wmrMkfkJYCxFwKQic8+RTZgWPuWxwAfjJElsXkex7DJjfSJsQIt931ilUgmwdA==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0", - "comma-separated-tokens": "^2.0.0", - "devlop": "^1.0.0", - "property-information": "^7.0.0", - "space-separated-tokens": "^2.0.0", - "web-namespaces": "^2.0.0", - "zwitch": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/hast-util-whitespace": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", - "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/hastscript": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-9.0.1.tgz", - "integrity": "sha512-g7df9rMFX/SPi34tyGCyUBREQoKkapwdY/T04Qn9TDWfHhAYt4/I0gMVirzK5wEzeUqIjEB+LXC/ypb7Aqno5w==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0", - "comma-separated-tokens": "^2.0.0", - "hast-util-parse-selector": "^4.0.0", - "property-information": "^7.0.0", - "space-separated-tokens": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/he": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", - "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", - "license": "MIT", - "bin": { - "he": "bin/he" - } - }, - "node_modules/history": { - "version": "4.10.1", - "resolved": "https://registry.npmjs.org/history/-/history-4.10.1.tgz", - "integrity": "sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==", - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.1.2", - "loose-envify": "^1.2.0", - "resolve-pathname": "^3.0.0", - "tiny-invariant": "^1.0.2", - "tiny-warning": "^1.0.0", - "value-equal": "^1.0.1" - } - }, - "node_modules/hoist-non-react-statics": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz", - "integrity": "sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==", - "license": "BSD-3-Clause", - "dependencies": { - "react-is": "^16.7.0" - } - }, - "node_modules/hpack.js": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/hpack.js/-/hpack.js-2.1.6.tgz", - "integrity": "sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ==", - "license": "MIT", - "dependencies": { - "inherits": "^2.0.1", - "obuf": "^1.0.0", - "readable-stream": "^2.0.1", - "wbuf": "^1.1.0" - } - }, - "node_modules/hpack.js/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", - "license": "MIT" - }, - "node_modules/hpack.js/node_modules/readable-stream": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", - "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", - "license": "MIT", - "dependencies": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "node_modules/hpack.js/node_modules/safe-buffer": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", - "license": "MIT" - }, - "node_modules/hpack.js/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, - "node_modules/html-escaper": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", - "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", - "license": "MIT" - }, - "node_modules/html-minifier-terser": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-7.2.0.tgz", - "integrity": "sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA==", - "license": "MIT", - "dependencies": { - "camel-case": "^4.1.2", - "clean-css": "~5.3.2", - "commander": "^10.0.0", - "entities": "^4.4.0", - "param-case": "^3.0.4", - "relateurl": "^0.2.7", - "terser": "^5.15.1" - }, - "bin": { - "html-minifier-terser": "cli.js" - }, - "engines": { - "node": "^14.13.1 || >=16.0.0" - } - }, - "node_modules/html-minifier-terser/node_modules/commander": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz", - "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", - "license": "MIT", - "engines": { - "node": ">=14" - } - }, - "node_modules/html-tags": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/html-tags/-/html-tags-3.3.1.tgz", - "integrity": "sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ==", - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/html-void-elements": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", - "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/html-webpack-plugin": { - "version": "5.6.6", - "resolved": "https://registry.npmjs.org/html-webpack-plugin/-/html-webpack-plugin-5.6.6.tgz", - "integrity": "sha512-bLjW01UTrvoWTJQL5LsMRo1SypHW80FTm12OJRSnr3v6YHNhfe+1r0MYUZJMACxnCHURVnBWRwAsWs2yPU9Ezw==", - "license": "MIT", - "dependencies": { - "@types/html-minifier-terser": "^6.0.0", - "html-minifier-terser": "^6.0.2", - "lodash": "^4.17.21", - "pretty-error": "^4.0.0", - "tapable": "^2.0.0" - }, - "engines": { - "node": ">=10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/html-webpack-plugin" - }, - "peerDependencies": { - "@rspack/core": "0.x || 1.x", - "webpack": "^5.20.0" - }, - "peerDependenciesMeta": { - "@rspack/core": { - "optional": true - }, - "webpack": { - "optional": true - } - } - }, - "node_modules/html-webpack-plugin/node_modules/commander": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", - "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==", - "license": "MIT", - "engines": { - "node": ">= 12" - } - }, - "node_modules/html-webpack-plugin/node_modules/html-minifier-terser": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", - "integrity": "sha512-YXxSlJBZTP7RS3tWnQw74ooKa6L9b9i9QYXY21eUEvhZ3u9XLfv6OnFsQq6RxkhHygsaUMvYsZRV5rU/OVNZxw==", - "license": "MIT", - "dependencies": { - "camel-case": "^4.1.2", - "clean-css": "^5.2.2", - "commander": "^8.3.0", - "he": "^1.2.0", - "param-case": "^3.0.4", - "relateurl": "^0.2.7", - "terser": "^5.10.0" - }, - "bin": { - "html-minifier-terser": "cli.js" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/htmlparser2": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-8.0.2.tgz", - "integrity": "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==", - "funding": [ - "https://github.com/fb55/htmlparser2?sponsor=1", - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ], - "license": "MIT", - "dependencies": { - "domelementtype": "^2.3.0", - "domhandler": "^5.0.3", - "domutils": "^3.0.1", - "entities": "^4.4.0" - } - }, - "node_modules/http-cache-semantics": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", - "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==", - "license": "BSD-2-Clause" - }, - "node_modules/http-deceiver": { - "version": "1.2.7", - "resolved": "https://registry.npmjs.org/http-deceiver/-/http-deceiver-1.2.7.tgz", - "integrity": "sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw==", - "license": "MIT" - }, - "node_modules/http-errors": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", - "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", - "license": "MIT", - "dependencies": { - "depd": "~2.0.0", - "inherits": "~2.0.4", - "setprototypeof": "~1.2.0", - "statuses": "~2.0.2", - "toidentifier": "~1.0.1" - }, - "engines": { - "node": ">= 0.8" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/express" - } - }, - "node_modules/http-parser-js": { - "version": "0.5.10", - "resolved": "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.5.10.tgz", - "integrity": "sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA==", - "license": "MIT" - }, - "node_modules/http-proxy": { - "version": "1.18.1", - "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.18.1.tgz", - "integrity": "sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==", - "license": "MIT", - "dependencies": { - "eventemitter3": "^4.0.0", - "follow-redirects": "^1.0.0", - "requires-port": "^1.0.0" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/http-proxy-middleware": { - "version": "2.0.9", - "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz", - "integrity": "sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q==", - "license": "MIT", - "dependencies": { - "@types/http-proxy": "^1.17.8", - "http-proxy": "^1.18.1", - "is-glob": "^4.0.1", - "is-plain-obj": "^3.0.0", - "micromatch": "^4.0.2" - }, - "engines": { - "node": ">=12.0.0" - }, - "peerDependencies": { - "@types/express": "^4.17.13" - }, - "peerDependenciesMeta": { - "@types/express": { - "optional": true - } - } - }, - "node_modules/http-proxy-middleware/node_modules/is-plain-obj": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-3.0.0.tgz", - "integrity": "sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/http2-wrapper": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.2.1.tgz", - "integrity": "sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ==", - "license": "MIT", - "dependencies": { - "quick-lru": "^5.1.1", - "resolve-alpn": "^1.2.0" - }, - "engines": { - "node": ">=10.19.0" - } - }, - "node_modules/human-signals": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", - "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.17.0" - } - }, - "node_modules/hyperdyperid": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/hyperdyperid/-/hyperdyperid-1.2.0.tgz", - "integrity": "sha512-Y93lCzHYgGWdrJ66yIktxiaGULYc6oGiABxhcO5AufBeOyoIdZF7bIfLaOrbM0iGIOXQQgxxRrFEnb+Y6w1n4A==", - "license": "MIT", - "engines": { - "node": ">=10.18" - } - }, - "node_modules/iconv-lite": { - "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", - "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/icss-utils": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/icss-utils/-/icss-utils-5.1.0.tgz", - "integrity": "sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA==", - "license": "ISC", - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/ignore": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", - "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/image-size": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/image-size/-/image-size-2.0.2.tgz", - "integrity": "sha512-IRqXKlaXwgSMAMtpNzZa1ZAe8m+Sa1770Dhk8VkSsP9LS+iHD62Zd8FQKs8fbPiagBE7BzoFX23cxFnwshpV6w==", - "license": "MIT", - "bin": { - "image-size": "bin/image-size.js" - }, - "engines": { - "node": ">=16.x" - } - }, - "node_modules/immediate": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/immediate/-/immediate-3.3.0.tgz", - "integrity": "sha512-HR7EVodfFUdQCTIeySw+WDRFJlPcLOJbXfwwZ7Oom6tjsvZ3bOkCDJHehQC3nxJrv7+f9XecwazynjU8e4Vw3Q==", - "license": "MIT" - }, - "node_modules/import-fresh": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", - "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", - "license": "MIT", - "dependencies": { - "parent-module": "^1.0.0", - "resolve-from": "^4.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/import-lazy": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", - "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/imurmurhash": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", - "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", - "license": "MIT", - "engines": { - "node": ">=0.8.19" - } - }, - "node_modules/indent-string": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", - "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/infima": { - "version": "0.2.0-alpha.45", - "resolved": "https://registry.npmjs.org/infima/-/infima-0.2.0-alpha.45.tgz", - "integrity": "sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw==", - "license": "MIT", - "engines": { - "node": ">=12" - } - }, - "node_modules/inherits": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", - "license": "ISC" - }, - "node_modules/ini": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", - "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", - "license": "ISC", - "engines": { - "node": ">=10" - } - }, - "node_modules/inline-style-parser": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/inline-style-parser/-/inline-style-parser-0.2.7.tgz", - "integrity": "sha512-Nb2ctOyNR8DqQoR0OwRG95uNWIC0C1lCgf5Naz5H6Ji72KZ8OcFZLz2P5sNgwlyoJ8Yif11oMuYs5pBQa86csA==", - "license": "MIT" - }, - "node_modules/invariant": { - "version": "2.2.4", - "resolved": "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz", - "integrity": "sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA==", - "license": "MIT", - "dependencies": { - "loose-envify": "^1.0.0" - } - }, - "node_modules/ipaddr.js": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-2.3.0.tgz", - "integrity": "sha512-Zv/pA+ciVFbCSBBjGfaKUya/CcGmUHzTydLMaTwrUUEM2DIEO3iZvueGxmacvmN50fGpGVKeTXpb2LcYQxeVdg==", - "license": "MIT", - "engines": { - "node": ">= 10" - } - }, - "node_modules/is-alphabetical": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", - "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/is-alphanumerical": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz", - "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==", - "license": "MIT", - "dependencies": { - "is-alphabetical": "^2.0.0", - "is-decimal": "^2.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/is-arrayish": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", - "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", - "license": "MIT" - }, - "node_modules/is-binary-path": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", - "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", - "license": "MIT", - "dependencies": { - "binary-extensions": "^2.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/is-ci": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", - "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", - "license": "MIT", - "dependencies": { - "ci-info": "^3.2.0" - }, - "bin": { - "is-ci": "bin.js" - } - }, - "node_modules/is-core-module": { - "version": "2.16.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", - "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", - "license": "MIT", - "dependencies": { - "hasown": "^2.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/is-decimal": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", - "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/is-docker": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", - "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==", - "license": "MIT", - "bin": { - "is-docker": "cli.js" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-extendable": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/is-glob": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "license": "MIT", - "dependencies": { - "is-extglob": "^2.1.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-hexadecimal": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", - "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/is-inside-container": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-inside-container/-/is-inside-container-1.0.0.tgz", - "integrity": "sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==", - "license": "MIT", - "dependencies": { - "is-docker": "^3.0.0" - }, - "bin": { - "is-inside-container": "cli.js" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-inside-container/node_modules/is-docker": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", - "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", - "license": "MIT", - "bin": { - "is-docker": "cli.js" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-installed-globally": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", - "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", - "license": "MIT", - "dependencies": { - "global-dirs": "^3.0.0", - "is-path-inside": "^3.0.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-network-error": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/is-network-error/-/is-network-error-1.3.1.tgz", - "integrity": "sha512-6QCxa49rQbmUWLfk0nuGqzql9U8uaV2H6279bRErPBHe/109hCzsLUBUHfbEtvLIHBd6hyXbgedBSHevm43Edw==", - "license": "MIT", - "engines": { - "node": ">=16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-npm": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.1.0.tgz", - "integrity": "sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA==", - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "license": "MIT", - "engines": { - "node": ">=0.12.0" - } - }, - "node_modules/is-obj": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", - "integrity": "sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-path-inside": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", - "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/is-plain-obj": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", - "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-plain-object": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", - "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", - "license": "MIT", - "dependencies": { - "isobject": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-regexp": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", - "integrity": "sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-stream": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", - "license": "MIT" - }, - "node_modules/is-wsl": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", - "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==", - "license": "MIT", - "dependencies": { - "is-docker": "^2.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/is-yarn-global": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.1.tgz", - "integrity": "sha512-/kppl+R+LO5VmhYSEWARUFjodS25D68gvj8W7z0I7OWhUla5xWu8KL6CtB2V0R6yqhnRgbcaREMr4EEM6htLPQ==", - "license": "MIT", - "engines": { - "node": ">=12" - } - }, - "node_modules/isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==", - "license": "MIT" - }, - "node_modules/isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "license": "ISC" - }, - "node_modules/isobject": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", - "integrity": "sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/jest-util": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.7.0.tgz", - "integrity": "sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==", - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "@types/node": "*", - "chalk": "^4.0.0", - "ci-info": "^3.2.0", - "graceful-fs": "^4.2.9", - "picomatch": "^2.2.3" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-worker": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.7.0.tgz", - "integrity": "sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==", - "license": "MIT", - "dependencies": { - "@types/node": "*", - "jest-util": "^29.7.0", - "merge-stream": "^2.0.0", - "supports-color": "^8.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/jest-worker/node_modules/supports-color": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", - "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/supports-color?sponsor=1" - } - }, - "node_modules/jiti": { - "version": "1.21.7", - "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.7.tgz", - "integrity": "sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A==", - "license": "MIT", - "bin": { - "jiti": "bin/jiti.js" - } - }, - "node_modules/joi": { - "version": "17.13.3", - "resolved": "https://registry.npmjs.org/joi/-/joi-17.13.3.tgz", - "integrity": "sha512-otDA4ldcIx+ZXsKHWmp0YizCweVRZG96J10b0FevjfuncLO1oX59THoAmHkNubYJ+9gWsYsp5k8v4ib6oDv1fA==", - "license": "BSD-3-Clause", - "dependencies": { - "@hapi/hoek": "^9.3.0", - "@hapi/topo": "^5.1.0", - "@sideway/address": "^4.1.5", - "@sideway/formula": "^3.0.1", - "@sideway/pinpoint": "^2.0.0" - } - }, - "node_modules/js-tokens": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", - "license": "MIT" - }, - "node_modules/js-yaml": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", - "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", - "license": "MIT", - "dependencies": { - "argparse": "^2.0.1" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/jsesc": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", - "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", - "license": "MIT", - "bin": { - "jsesc": "bin/jsesc" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/json-buffer": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", - "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "license": "MIT" - }, - "node_modules/json-parse-even-better-errors": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", - "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", - "license": "MIT" - }, - "node_modules/json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", - "license": "MIT" - }, - "node_modules/json5": { - "version": "2.2.3", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", - "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", - "license": "MIT", - "bin": { - "json5": "lib/cli.js" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/jsonfile": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", - "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", - "license": "MIT", - "dependencies": { - "universalify": "^2.0.0" - }, - "optionalDependencies": { - "graceful-fs": "^4.1.6" - } - }, - "node_modules/keyv": { - "version": "4.5.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", - "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", - "license": "MIT", - "dependencies": { - "json-buffer": "3.0.1" - } - }, - "node_modules/kind-of": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", - "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/klaw-sync": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/klaw-sync/-/klaw-sync-6.0.0.tgz", - "integrity": "sha512-nIeuVSzdCCs6TDPTqI8w1Yre34sSq7AkZ4B3sfOBbI2CgVSB4Du4aLQijFU2+lhAFCwt9+42Hel6lQNIv6AntQ==", - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.1.11" - } - }, - "node_modules/kleur": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", - "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/latest-version": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", - "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", - "license": "MIT", - "dependencies": { - "package-json": "^8.1.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/launch-editor": { - "version": "2.13.2", - "resolved": "https://registry.npmjs.org/launch-editor/-/launch-editor-2.13.2.tgz", - "integrity": "sha512-4VVDnbOpLXy/s8rdRCSXb+zfMeFR0WlJWpET1iA9CQdlZDfwyLjUuGQzXU4VeOoey6AicSAluWan7Etga6Kcmg==", - "license": "MIT", - "dependencies": { - "picocolors": "^1.1.1", - "shell-quote": "^1.8.3" - } - }, - "node_modules/leven": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", - "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/lilconfig": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.3.tgz", - "integrity": "sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/antonk52" - } - }, - "node_modules/lines-and-columns": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", - "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", - "license": "MIT" - }, - "node_modules/linkify-it": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", - "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "uc.micro": "^2.0.0" - } - }, - "node_modules/loader-runner": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.1.tgz", - "integrity": "sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q==", - "license": "MIT", - "engines": { - "node": ">=6.11.5" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/loader-utils": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.4.tgz", - "integrity": "sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw==", - "license": "MIT", - "dependencies": { - "big.js": "^5.2.2", - "emojis-list": "^3.0.0", - "json5": "^2.1.2" - }, - "engines": { - "node": ">=8.9.0" - } - }, - "node_modules/locate-path": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-7.2.0.tgz", - "integrity": "sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA==", - "license": "MIT", - "dependencies": { - "p-locate": "^6.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/lodash": { - "version": "4.17.23", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", - "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", - "license": "MIT" - }, - "node_modules/lodash.debounce": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", - "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==", - "license": "MIT" - }, - "node_modules/lodash.memoize": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", - "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==", - "license": "MIT" - }, - "node_modules/lodash.uniq": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.uniq/-/lodash.uniq-4.5.0.tgz", - "integrity": "sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==", - "license": "MIT" - }, - "node_modules/longest-streak": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-3.1.0.tgz", - "integrity": "sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/loose-envify": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", - "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", - "license": "MIT", - "dependencies": { - "js-tokens": "^3.0.0 || ^4.0.0" - }, - "bin": { - "loose-envify": "cli.js" - } - }, - "node_modules/lower-case": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", - "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", - "license": "MIT", - "dependencies": { - "tslib": "^2.0.3" - } - }, - "node_modules/lowercase-keys": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", - "integrity": "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==", - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/lru-cache": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", - "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", - "license": "ISC", - "dependencies": { - "yallist": "^3.0.2" - } - }, - "node_modules/lunr": { - "version": "2.3.9", - "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", - "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", - "license": "MIT" - }, - "node_modules/lunr-languages": { - "version": "1.14.0", - "resolved": "https://registry.npmjs.org/lunr-languages/-/lunr-languages-1.14.0.tgz", - "integrity": "sha512-hWUAb2KqM3L7J5bcrngszzISY4BxrXn/Xhbb9TTCJYEGqlR1nG67/M14sp09+PTIRklobrn57IAxcdcO/ZFyNA==", - "license": "MPL-1.1" - }, - "node_modules/mark.js": { - "version": "8.11.1", - "resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz", - "integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==", - "license": "MIT" - }, - "node_modules/markdown-extensions": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz", - "integrity": "sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==", - "license": "MIT", - "engines": { - "node": ">=16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/markdown-it": { - "version": "14.1.1", - "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.1.tgz", - "integrity": "sha512-BuU2qnTti9YKgK5N+IeMubp14ZUKUUw7yeJbkjtosvHiP0AZ5c8IAgEMk79D0eC8F23r4Ac/q8cAIFdm2FtyoA==", - "dev": true, - "license": "MIT", - "dependencies": { - "argparse": "^2.0.1", - "entities": "^4.4.0", - "linkify-it": "^5.0.0", - "mdurl": "^2.0.0", - "punycode.js": "^2.3.1", - "uc.micro": "^2.1.0" - }, - "bin": { - "markdown-it": "bin/markdown-it.mjs" - } - }, - "node_modules/markdown-table": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.4.tgz", - "integrity": "sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/math-intrinsics": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", - "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/mdast-util-directive": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/mdast-util-directive/-/mdast-util-directive-3.1.0.tgz", - "integrity": "sha512-I3fNFt+DHmpWCYAT7quoM6lHf9wuqtI+oCOfvILnoicNIqjh5E3dEJWiXuYME2gNe8vl1iMQwyUHa7bgFmak6Q==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "@types/unist": "^3.0.0", - "ccount": "^2.0.0", - "devlop": "^1.0.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0", - "parse-entities": "^4.0.0", - "stringify-entities": "^4.0.0", - "unist-util-visit-parents": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-find-and-replace": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.2.tgz", - "integrity": "sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "escape-string-regexp": "^5.0.0", - "unist-util-is": "^6.0.0", - "unist-util-visit-parents": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-find-and-replace/node_modules/escape-string-regexp": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", - "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/mdast-util-from-markdown": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.3.tgz", - "integrity": "sha512-W4mAWTvSlKvf8L6J+VN9yLSqQ9AOAAvHuoDAmPkz4dHf553m5gVj2ejadHJhoJmcmxEnOv6Pa8XJhpxE93kb8Q==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "@types/unist": "^3.0.0", - "decode-named-character-reference": "^1.0.0", - "devlop": "^1.0.0", - "mdast-util-to-string": "^4.0.0", - "micromark": "^4.0.0", - "micromark-util-decode-numeric-character-reference": "^2.0.0", - "micromark-util-decode-string": "^2.0.0", - "micromark-util-normalize-identifier": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0", - "unist-util-stringify-position": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-from-markdown/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/mdast-util-frontmatter": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/mdast-util-frontmatter/-/mdast-util-frontmatter-2.0.1.tgz", - "integrity": "sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "devlop": "^1.0.0", - "escape-string-regexp": "^5.0.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0", - "micromark-extension-frontmatter": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-frontmatter/node_modules/escape-string-regexp": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", - "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/mdast-util-gfm": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/mdast-util-gfm/-/mdast-util-gfm-3.1.0.tgz", - "integrity": "sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ==", - "license": "MIT", - "dependencies": { - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-gfm-autolink-literal": "^2.0.0", - "mdast-util-gfm-footnote": "^2.0.0", - "mdast-util-gfm-strikethrough": "^2.0.0", - "mdast-util-gfm-table": "^2.0.0", - "mdast-util-gfm-task-list-item": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-gfm-autolink-literal": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/mdast-util-gfm-autolink-literal/-/mdast-util-gfm-autolink-literal-2.0.1.tgz", - "integrity": "sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "ccount": "^2.0.0", - "devlop": "^1.0.0", - "mdast-util-find-and-replace": "^3.0.0", - "micromark-util-character": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-gfm-autolink-literal/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/mdast-util-gfm-autolink-literal/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/mdast-util-gfm-footnote": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.1.0.tgz", - "integrity": "sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "devlop": "^1.1.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0", - "micromark-util-normalize-identifier": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-gfm-strikethrough": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/mdast-util-gfm-strikethrough/-/mdast-util-gfm-strikethrough-2.0.0.tgz", - "integrity": "sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-gfm-table": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/mdast-util-gfm-table/-/mdast-util-gfm-table-2.0.0.tgz", - "integrity": "sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "devlop": "^1.0.0", - "markdown-table": "^3.0.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-gfm-task-list-item": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/mdast-util-gfm-task-list-item/-/mdast-util-gfm-task-list-item-2.0.0.tgz", - "integrity": "sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "devlop": "^1.0.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-mdx": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz", - "integrity": "sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w==", - "license": "MIT", - "dependencies": { - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-mdx-expression": "^2.0.0", - "mdast-util-mdx-jsx": "^3.0.0", - "mdast-util-mdxjs-esm": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-mdx-expression": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.1.tgz", - "integrity": "sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ==", - "license": "MIT", - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "@types/hast": "^3.0.0", - "@types/mdast": "^4.0.0", - "devlop": "^1.0.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-mdx-jsx": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.2.0.tgz", - "integrity": "sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q==", - "license": "MIT", - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "@types/hast": "^3.0.0", - "@types/mdast": "^4.0.0", - "@types/unist": "^3.0.0", - "ccount": "^2.0.0", - "devlop": "^1.1.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0", - "parse-entities": "^4.0.0", - "stringify-entities": "^4.0.0", - "unist-util-stringify-position": "^4.0.0", - "vfile-message": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-mdxjs-esm": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz", - "integrity": "sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==", - "license": "MIT", - "dependencies": { - "@types/estree-jsx": "^1.0.0", - "@types/hast": "^3.0.0", - "@types/mdast": "^4.0.0", - "devlop": "^1.0.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-phrasing": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz", - "integrity": "sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "unist-util-is": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-to-hast": { - "version": "13.2.1", - "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.1.tgz", - "integrity": "sha512-cctsq2wp5vTsLIcaymblUriiTcZd0CwWtCbLvrOzYCDZoWyMNV8sZ7krj09FSnsiJi3WVsHLM4k6Dq/yaPyCXA==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0", - "@types/mdast": "^4.0.0", - "@ungap/structured-clone": "^1.0.0", - "devlop": "^1.0.0", - "micromark-util-sanitize-uri": "^2.0.0", - "trim-lines": "^3.0.0", - "unist-util-position": "^5.0.0", - "unist-util-visit": "^5.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-to-markdown": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.2.tgz", - "integrity": "sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "@types/unist": "^3.0.0", - "longest-streak": "^3.0.0", - "mdast-util-phrasing": "^4.0.0", - "mdast-util-to-string": "^4.0.0", - "micromark-util-classify-character": "^2.0.0", - "micromark-util-decode-string": "^2.0.0", - "unist-util-visit": "^5.0.0", - "zwitch": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-to-string": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz", - "integrity": "sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdn-data": { - "version": "2.0.30", - "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.30.tgz", - "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==", - "license": "CC0-1.0" - }, - "node_modules/mdurl": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", - "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", - "dev": true, - "license": "MIT" - }, - "node_modules/media-typer": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", - "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/memfs": { - "version": "4.57.1", - "resolved": "https://registry.npmjs.org/memfs/-/memfs-4.57.1.tgz", - "integrity": "sha512-WvzrWPwMQT+PtbX2Et64R4qXKK0fj/8pO85MrUCzymX3twwCiJCdvntW3HdhG1teLJcHDDLIKx5+c3HckWYZtQ==", - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/fs-core": "4.57.1", - "@jsonjoy.com/fs-fsa": "4.57.1", - "@jsonjoy.com/fs-node": "4.57.1", - "@jsonjoy.com/fs-node-builtins": "4.57.1", - "@jsonjoy.com/fs-node-to-fsa": "4.57.1", - "@jsonjoy.com/fs-node-utils": "4.57.1", - "@jsonjoy.com/fs-print": "4.57.1", - "@jsonjoy.com/fs-snapshot": "4.57.1", - "@jsonjoy.com/json-pack": "^1.11.0", - "@jsonjoy.com/util": "^1.9.0", - "glob-to-regex.js": "^1.0.1", - "thingies": "^2.5.0", - "tree-dump": "^1.0.3", - "tslib": "^2.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/merge-descriptors": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz", - "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==", - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/merge-stream": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", - "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", - "license": "MIT" - }, - "node_modules/merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/methods": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", - "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/micromark": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", - "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "@types/debug": "^4.0.0", - "debug": "^4.0.0", - "decode-named-character-reference": "^1.0.0", - "devlop": "^1.0.0", - "micromark-core-commonmark": "^2.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-chunked": "^2.0.0", - "micromark-util-combine-extensions": "^2.0.0", - "micromark-util-decode-numeric-character-reference": "^2.0.0", - "micromark-util-encode": "^2.0.0", - "micromark-util-normalize-identifier": "^2.0.0", - "micromark-util-resolve-all": "^2.0.0", - "micromark-util-sanitize-uri": "^2.0.0", - "micromark-util-subtokenize": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-core-commonmark": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz", - "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "decode-named-character-reference": "^1.0.0", - "devlop": "^1.0.0", - "micromark-factory-destination": "^2.0.0", - "micromark-factory-label": "^2.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-factory-title": "^2.0.0", - "micromark-factory-whitespace": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-chunked": "^2.0.0", - "micromark-util-classify-character": "^2.0.0", - "micromark-util-html-tag-name": "^2.0.0", - "micromark-util-normalize-identifier": "^2.0.0", - "micromark-util-resolve-all": "^2.0.0", - "micromark-util-subtokenize": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-core-commonmark/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-core-commonmark/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-core-commonmark/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-directive": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-3.0.2.tgz", - "integrity": "sha512-wjcXHgk+PPdmvR58Le9d7zQYWy+vKEU9Se44p2CrCDPiLr2FMyiT4Fyb5UFKFC66wGB3kPlgD7q3TnoqPS7SZA==", - "license": "MIT", - "dependencies": { - "devlop": "^1.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-factory-whitespace": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0", - "parse-entities": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-directive/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-directive/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-directive/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-frontmatter": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/micromark-extension-frontmatter/-/micromark-extension-frontmatter-2.0.0.tgz", - "integrity": "sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg==", - "license": "MIT", - "dependencies": { - "fault": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-frontmatter/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-frontmatter/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-gfm": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz", - "integrity": "sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w==", - "license": "MIT", - "dependencies": { - "micromark-extension-gfm-autolink-literal": "^2.0.0", - "micromark-extension-gfm-footnote": "^2.0.0", - "micromark-extension-gfm-strikethrough": "^2.0.0", - "micromark-extension-gfm-table": "^2.0.0", - "micromark-extension-gfm-tagfilter": "^2.0.0", - "micromark-extension-gfm-task-list-item": "^2.0.0", - "micromark-util-combine-extensions": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-gfm-autolink-literal": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz", - "integrity": "sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==", - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-sanitize-uri": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-gfm-autolink-literal/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-gfm-autolink-literal/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-gfm-footnote": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz", - "integrity": "sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==", - "license": "MIT", - "dependencies": { - "devlop": "^1.0.0", - "micromark-core-commonmark": "^2.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-normalize-identifier": "^2.0.0", - "micromark-util-sanitize-uri": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-gfm-strikethrough": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/micromark-extension-gfm-strikethrough/-/micromark-extension-gfm-strikethrough-2.1.0.tgz", - "integrity": "sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw==", - "license": "MIT", - "dependencies": { - "devlop": "^1.0.0", - "micromark-util-chunked": "^2.0.0", - "micromark-util-classify-character": "^2.0.0", - "micromark-util-resolve-all": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-gfm-strikethrough/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-gfm-table": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz", - "integrity": "sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==", - "license": "MIT", - "dependencies": { - "devlop": "^1.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-gfm-table/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-gfm-table/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-gfm-table/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-gfm-tagfilter": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/micromark-extension-gfm-tagfilter/-/micromark-extension-gfm-tagfilter-2.0.0.tgz", - "integrity": "sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg==", - "license": "MIT", - "dependencies": { - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-gfm-task-list-item": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/micromark-extension-gfm-task-list-item/-/micromark-extension-gfm-task-list-item-2.1.0.tgz", - "integrity": "sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw==", - "license": "MIT", - "dependencies": { - "devlop": "^1.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-mdx-expression": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.1.tgz", - "integrity": "sha512-dD/ADLJ1AeMvSAKBwO22zG22N4ybhe7kFIZ3LsDI0GlsNr2A3KYxb0LdC1u5rj4Nw+CHKY0RVdnHX8vj8ejm4Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "devlop": "^1.0.0", - "micromark-factory-mdx-expression": "^2.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-events-to-acorn": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-mdx-expression/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-mdx-expression/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-mdx-expression/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-mdx-jsx": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/micromark-extension-mdx-jsx/-/micromark-extension-mdx-jsx-3.0.2.tgz", - "integrity": "sha512-e5+q1DjMh62LZAJOnDraSSbDMvGJ8x3cbjygy2qFEi7HCeUT4BDKCvMozPozcD6WmOt6sVvYDNBKhFSz3kjOVQ==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "devlop": "^1.0.0", - "estree-util-is-identifier-name": "^3.0.0", - "micromark-factory-mdx-expression": "^2.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-events-to-acorn": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0", - "vfile-message": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-extension-mdx-md": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/micromark-extension-mdx-md/-/micromark-extension-mdx-md-2.0.0.tgz", - "integrity": "sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ==", - "license": "MIT", - "dependencies": { - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-mdxjs": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs/-/micromark-extension-mdxjs-3.0.0.tgz", - "integrity": "sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ==", - "license": "MIT", - "dependencies": { - "acorn": "^8.0.0", - "acorn-jsx": "^5.0.0", - "micromark-extension-mdx-expression": "^3.0.0", - "micromark-extension-mdx-jsx": "^3.0.0", - "micromark-extension-mdx-md": "^2.0.0", - "micromark-extension-mdxjs-esm": "^3.0.0", - "micromark-util-combine-extensions": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-mdxjs-esm": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs-esm/-/micromark-extension-mdxjs-esm-3.0.0.tgz", - "integrity": "sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "devlop": "^1.0.0", - "micromark-core-commonmark": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-events-to-acorn": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0", - "unist-util-position-from-estree": "^2.0.0", - "vfile-message": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/micromark-extension-mdxjs-esm/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-extension-mdxjs-esm/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-factory-destination": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz", - "integrity": "sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-destination/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-destination/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-factory-label": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz", - "integrity": "sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "devlop": "^1.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-label/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-label/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-factory-mdx-expression": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/micromark-factory-mdx-expression/-/micromark-factory-mdx-expression-2.0.3.tgz", - "integrity": "sha512-kQnEtA3vzucU2BkrIa8/VaSAsP+EJ3CKOvhMuJgOEGg9KDC6OAY6nSnNDVRiVNRqj7Y4SlSzcStaH/5jge8JdQ==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "devlop": "^1.0.0", - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-events-to-acorn": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0", - "unist-util-position-from-estree": "^2.0.0", - "vfile-message": "^4.0.0" - } - }, - "node_modules/micromark-factory-mdx-expression/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-mdx-expression/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-mdx-expression/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-factory-space": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-1.1.0.tgz", - "integrity": "sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^1.0.0", - "micromark-util-types": "^1.0.0" - } - }, - "node_modules/micromark-factory-space/node_modules/micromark-util-types": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", - "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-factory-title": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz", - "integrity": "sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-title/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-title/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-title/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-factory-whitespace": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz", - "integrity": "sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-factory-space": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-whitespace/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-whitespace/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-factory-whitespace/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-character": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-1.2.0.tgz", - "integrity": "sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0" - } - }, - "node_modules/micromark-util-character/node_modules/micromark-util-types": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", - "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-chunked": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz", - "integrity": "sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0" - } - }, - "node_modules/micromark-util-chunked/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-classify-character": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz", - "integrity": "sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-util-classify-character/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-util-classify-character/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-combine-extensions": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz", - "integrity": "sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-chunked": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-util-decode-numeric-character-reference": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz", - "integrity": "sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0" - } - }, - "node_modules/micromark-util-decode-numeric-character-reference/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-decode-string": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-2.0.1.tgz", - "integrity": "sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "decode-named-character-reference": "^1.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-decode-numeric-character-reference": "^2.0.0", - "micromark-util-symbol": "^2.0.0" - } - }, - "node_modules/micromark-util-decode-string/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-util-decode-string/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-encode": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", - "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-events-to-acorn": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/micromark-util-events-to-acorn/-/micromark-util-events-to-acorn-2.0.3.tgz", - "integrity": "sha512-jmsiEIiZ1n7X1Rr5k8wVExBQCg5jy4UXVADItHmNk1zkwEVhBuIUKRu3fqv+hs4nxLISi2DQGlqIOGiFxgbfHg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "@types/unist": "^3.0.0", - "devlop": "^1.0.0", - "estree-util-visit": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0", - "vfile-message": "^4.0.0" - } - }, - "node_modules/micromark-util-events-to-acorn/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-html-tag-name": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz", - "integrity": "sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-normalize-identifier": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz", - "integrity": "sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0" - } - }, - "node_modules/micromark-util-normalize-identifier/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-resolve-all": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz", - "integrity": "sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-util-sanitize-uri": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", - "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-encode": "^2.0.0", - "micromark-util-symbol": "^2.0.0" - } - }, - "node_modules/micromark-util-sanitize-uri/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-util-sanitize-uri/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-subtokenize": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz", - "integrity": "sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "devlop": "^1.0.0", - "micromark-util-chunked": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark-util-subtokenize/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-symbol": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-1.1.0.tgz", - "integrity": "sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark-util-types": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", - "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromark/node_modules/micromark-factory-space": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", - "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark/node_modules/micromark-util-character": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", - "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - } - }, - "node_modules/micromark/node_modules/micromark-util-symbol": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", - "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/micromatch": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", - "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", - "license": "MIT", - "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/mime": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", - "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", - "license": "MIT", - "bin": { - "mime": "cli.js" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/mime-db": { - "version": "1.33.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz", - "integrity": "sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/mime-types": { - "version": "2.1.18", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz", - "integrity": "sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ==", - "license": "MIT", - "dependencies": { - "mime-db": "~1.33.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/mimic-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/mimic-response": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-4.0.0.tgz", - "integrity": "sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg==", - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/mini-css-extract-plugin": { - "version": "2.10.2", - "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-2.10.2.tgz", - "integrity": "sha512-AOSS0IdEB95ayVkxn5oGzNQwqAi2J0Jb/kKm43t7H73s8+f5873g0yuj0PNvK4dO75mu5DHg4nlgp4k6Kga8eg==", - "license": "MIT", - "dependencies": { - "schema-utils": "^4.0.0", - "tapable": "^2.2.1" - }, - "engines": { - "node": ">= 12.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.0.0" - } - }, - "node_modules/minimalistic-assert": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz", - "integrity": "sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==", - "license": "ISC" - }, - "node_modules/minimatch": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", - "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/minimist": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", - "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/mrmime": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.1.tgz", - "integrity": "sha512-Y3wQdFg2Va6etvQ5I82yUhGdsKrcYox6p7FfL1LbK2J4V01F9TGlepTIhnK24t7koZibmg82KGglhA1XK5IsLQ==", - "license": "MIT", - "engines": { - "node": ">=10" - } - }, - "node_modules/ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "license": "MIT" - }, - "node_modules/multicast-dns": { - "version": "7.2.5", - "resolved": "https://registry.npmjs.org/multicast-dns/-/multicast-dns-7.2.5.tgz", - "integrity": "sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg==", - "license": "MIT", - "dependencies": { - "dns-packet": "^5.2.2", - "thunky": "^1.0.2" - }, - "bin": { - "multicast-dns": "cli.js" - } - }, - "node_modules/nanoid": { - "version": "3.3.11", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", - "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "MIT", - "bin": { - "nanoid": "bin/nanoid.cjs" - }, - "engines": { - "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" - } - }, - "node_modules/negotiator": { - "version": "0.6.4", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.4.tgz", - "integrity": "sha512-myRT3DiWPHqho5PrJaIRyaMv2kgYf0mUVgBNOYMuCH5Ki1yEiQaf/ZJuQ62nvpc44wL5WDbTX7yGJi1Neevw8w==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/neo-async": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "license": "MIT" - }, - "node_modules/no-case": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", - "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", - "license": "MIT", - "dependencies": { - "lower-case": "^2.0.2", - "tslib": "^2.0.3" - } - }, - "node_modules/node-emoji": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/node-emoji/-/node-emoji-2.2.0.tgz", - "integrity": "sha512-Z3lTE9pLaJF47NyMhd4ww1yFTAP8YhYI8SleJiHzM46Fgpm5cnNzSl9XfzFNqbaz+VlJrIj3fXQ4DeN1Rjm6cw==", - "license": "MIT", - "dependencies": { - "@sindresorhus/is": "^4.6.0", - "char-regex": "^1.0.2", - "emojilib": "^2.4.0", - "skin-tone": "^2.0.0" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/node-releases": { - "version": "2.0.36", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.36.tgz", - "integrity": "sha512-TdC8FSgHz8Mwtw9g5L4gR/Sh9XhSP/0DEkQxfEFXOpiul5IiHgHan2VhYYb6agDSfp4KuvltmGApc8HMgUrIkA==", - "license": "MIT" - }, - "node_modules/normalize-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", - "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/normalize-url": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-8.1.1.tgz", - "integrity": "sha512-JYc0DPlpGWB40kH5g07gGTrYuMqV653k3uBKY6uITPWds3M0ov3GaWGp9lbE3Bzngx8+XkfzgvASb9vk9JDFXQ==", - "license": "MIT", - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/npm-run-path": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", - "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", - "license": "MIT", - "dependencies": { - "path-key": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/nprogress": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/nprogress/-/nprogress-0.2.0.tgz", - "integrity": "sha512-I19aIingLgR1fmhftnbWWO3dXc0hSxqHQHQb3H8m+K3TnEn/iSeTZZOyvKXWqQESMwuUVnatlCnZdLBZZt2VSA==", - "license": "MIT" - }, - "node_modules/nth-check": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", - "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", - "license": "BSD-2-Clause", - "dependencies": { - "boolbase": "^1.0.0" - }, - "funding": { - "url": "https://github.com/fb55/nth-check?sponsor=1" - } - }, - "node_modules/null-loader": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/null-loader/-/null-loader-4.0.1.tgz", - "integrity": "sha512-pxqVbi4U6N26lq+LmgIbB5XATP0VdZKOG25DhHi8btMmJJefGArFyDg1yc4U3hWCJbMqSrw0qyrz1UQX+qYXqg==", - "license": "MIT", - "dependencies": { - "loader-utils": "^2.0.0", - "schema-utils": "^3.0.0" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^4.0.0 || ^5.0.0" - } - }, - "node_modules/null-loader/node_modules/ajv": { - "version": "6.14.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", - "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/null-loader/node_modules/ajv-keywords": { - "version": "3.5.2", - "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", - "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", - "license": "MIT", - "peerDependencies": { - "ajv": "^6.9.1" - } - }, - "node_modules/null-loader/node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "license": "MIT" - }, - "node_modules/null-loader/node_modules/schema-utils": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", - "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", - "license": "MIT", - "dependencies": { - "@types/json-schema": "^7.0.8", - "ajv": "^6.12.5", - "ajv-keywords": "^3.5.2" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/object-assign": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", - "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/object-inspect": { - "version": "1.13.4", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", - "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/object-keys": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", - "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/object.assign": { - "version": "4.1.7", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", - "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", - "license": "MIT", - "dependencies": { - "call-bind": "^1.0.8", - "call-bound": "^1.0.3", - "define-properties": "^1.2.1", - "es-object-atoms": "^1.0.0", - "has-symbols": "^1.1.0", - "object-keys": "^1.1.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/obuf": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/obuf/-/obuf-1.1.2.tgz", - "integrity": "sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg==", - "license": "MIT" - }, - "node_modules/on-finished": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", - "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", - "license": "MIT", - "dependencies": { - "ee-first": "1.1.1" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/on-headers": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/on-headers/-/on-headers-1.1.0.tgz", - "integrity": "sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/onetime": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", - "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", - "license": "MIT", - "dependencies": { - "mimic-fn": "^2.1.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/open": { - "version": "8.4.2", - "resolved": "https://registry.npmjs.org/open/-/open-8.4.2.tgz", - "integrity": "sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==", - "license": "MIT", - "dependencies": { - "define-lazy-prop": "^2.0.0", - "is-docker": "^2.1.1", - "is-wsl": "^2.2.0" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/opener": { - "version": "1.5.2", - "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", - "integrity": "sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==", - "license": "(WTFPL OR MIT)", - "bin": { - "opener": "bin/opener-bin.js" - } - }, - "node_modules/p-cancelable": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-3.0.0.tgz", - "integrity": "sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw==", - "license": "MIT", - "engines": { - "node": ">=12.20" - } - }, - "node_modules/p-finally": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", - "integrity": "sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/p-limit": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-4.0.0.tgz", - "integrity": "sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ==", - "license": "MIT", - "dependencies": { - "yocto-queue": "^1.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-locate": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-6.0.0.tgz", - "integrity": "sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw==", - "license": "MIT", - "dependencies": { - "p-limit": "^4.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-map": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", - "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", - "license": "MIT", - "dependencies": { - "aggregate-error": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-queue": { - "version": "6.6.2", - "resolved": "https://registry.npmjs.org/p-queue/-/p-queue-6.6.2.tgz", - "integrity": "sha512-RwFpb72c/BhQLEXIZ5K2e+AhgNVmIejGlTgiB9MzZ0e93GRvqZ7uSi0dvRF7/XIXDeNkra2fNHBxTyPDGySpjQ==", - "license": "MIT", - "dependencies": { - "eventemitter3": "^4.0.4", - "p-timeout": "^3.2.0" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-retry": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/p-retry/-/p-retry-6.2.1.tgz", - "integrity": "sha512-hEt02O4hUct5wtwg4H4KcWgDdm+l1bOaEy/hWzd8xtXB9BqxTWBBhb+2ImAtH4Cv4rPjV76xN3Zumqk3k3AhhQ==", - "license": "MIT", - "dependencies": { - "@types/retry": "0.12.2", - "is-network-error": "^1.0.0", - "retry": "^0.13.1" - }, - "engines": { - "node": ">=16.17" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/p-timeout": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/p-timeout/-/p-timeout-3.2.0.tgz", - "integrity": "sha512-rhIwUycgwwKcP9yTOOFK/AKsAopjjCakVqLHePO3CC6Mir1Z99xT+R63jZxAT5lFZLa2inS5h+ZS2GvR99/FBg==", - "license": "MIT", - "dependencies": { - "p-finally": "^1.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/package-json": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.1.tgz", - "integrity": "sha512-cbH9IAIJHNj9uXi196JVsRlt7cHKak6u/e6AkL/bkRelZ7rlL3X1YKxsZwa36xipOEKAsdtmaG6aAJoM1fx2zA==", - "license": "MIT", - "dependencies": { - "got": "^12.1.0", - "registry-auth-token": "^5.0.1", - "registry-url": "^6.0.0", - "semver": "^7.3.7" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/param-case": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", - "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", - "license": "MIT", - "dependencies": { - "dot-case": "^3.0.4", - "tslib": "^2.0.3" - } - }, - "node_modules/parent-module": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", - "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", - "license": "MIT", - "dependencies": { - "callsites": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/parse-entities": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.2.tgz", - "integrity": "sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==", - "license": "MIT", - "dependencies": { - "@types/unist": "^2.0.0", - "character-entities-legacy": "^3.0.0", - "character-reference-invalid": "^2.0.0", - "decode-named-character-reference": "^1.0.0", - "is-alphanumerical": "^2.0.0", - "is-decimal": "^2.0.0", - "is-hexadecimal": "^2.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/parse-entities/node_modules/@types/unist": { - "version": "2.0.11", - "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.11.tgz", - "integrity": "sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==", - "license": "MIT" - }, - "node_modules/parse-json": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", - "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", - "license": "MIT", - "dependencies": { - "@babel/code-frame": "^7.0.0", - "error-ex": "^1.3.1", - "json-parse-even-better-errors": "^2.3.0", - "lines-and-columns": "^1.1.6" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/parse-numeric-range": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz", - "integrity": "sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ==", - "license": "ISC" - }, - "node_modules/parse5": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", - "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", - "license": "MIT", - "dependencies": { - "entities": "^6.0.0" - }, - "funding": { - "url": "https://github.com/inikulin/parse5?sponsor=1" - } - }, - "node_modules/parse5-htmlparser2-tree-adapter": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz", - "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==", - "license": "MIT", - "dependencies": { - "domhandler": "^5.0.3", - "parse5": "^7.0.0" - }, - "funding": { - "url": "https://github.com/inikulin/parse5?sponsor=1" - } - }, - "node_modules/parse5-parser-stream": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/parse5-parser-stream/-/parse5-parser-stream-7.1.2.tgz", - "integrity": "sha512-JyeQc9iwFLn5TbvvqACIF/VXG6abODeB3Fwmv/TGdLk2LfbWkaySGY72at4+Ty7EkPZj854u4CrICqNk2qIbow==", - "license": "MIT", - "dependencies": { - "parse5": "^7.0.0" - }, - "funding": { - "url": "https://github.com/inikulin/parse5?sponsor=1" - } - }, - "node_modules/parse5/node_modules/entities": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", - "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", - "license": "BSD-2-Clause", - "engines": { - "node": ">=0.12" - }, - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, - "node_modules/parseurl": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", - "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/pascal-case": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", - "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", - "license": "MIT", - "dependencies": { - "no-case": "^3.0.4", - "tslib": "^2.0.3" - } - }, - "node_modules/path-exists": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-5.0.0.tgz", - "integrity": "sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==", - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - } - }, - "node_modules/path-is-inside": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", - "integrity": "sha512-DUWJr3+ULp4zXmol/SZkFf3JGsS9/SIv+Y3Rt93/UjPpDpklB5f1er4O3POIbUuUJ3FXgqte2Q7SrU6zAqwk8w==", - "license": "(WTFPL OR MIT)" - }, - "node_modules/path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/path-parse": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", - "license": "MIT" - }, - "node_modules/path-to-regexp": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", - "integrity": "sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g==", - "license": "MIT", - "dependencies": { - "isarray": "0.0.1" - } - }, - "node_modules/path-type": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/picocolors": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", - "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", - "license": "ISC" - }, - "node_modules/picomatch": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", - "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", - "license": "MIT", - "engines": { - "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, - "node_modules/pkg-dir": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-7.0.0.tgz", - "integrity": "sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA==", - "license": "MIT", - "dependencies": { - "find-up": "^6.3.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pkijs": { - "version": "3.4.0", - "resolved": "https://registry.npmjs.org/pkijs/-/pkijs-3.4.0.tgz", - "integrity": "sha512-emEcLuomt2j03vxD54giVB4SxTjnsqkU692xZOZXHDVoYyypEm+b3jpiTcc+Cf+myooc+/Ly0z01jqeNHVgJGw==", - "license": "BSD-3-Clause", - "dependencies": { - "@noble/hashes": "1.4.0", - "asn1js": "^3.0.6", - "bytestreamjs": "^2.0.1", - "pvtsutils": "^1.3.6", - "pvutils": "^1.1.3", - "tslib": "^2.8.1" - }, - "engines": { - "node": ">=16.0.0" - } - }, - "node_modules/postcss": { - "version": "8.5.8", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz", - "integrity": "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg==", - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/postcss" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "MIT", - "dependencies": { - "nanoid": "^3.3.11", - "picocolors": "^1.1.1", - "source-map-js": "^1.2.1" - }, - "engines": { - "node": "^10 || ^12 || >=14" - } - }, - "node_modules/postcss-attribute-case-insensitive": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-attribute-case-insensitive/-/postcss-attribute-case-insensitive-7.0.1.tgz", - "integrity": "sha512-Uai+SupNSqzlschRyNx3kbCTWgY/2hcwtHEI/ej2LJWc9JJ77qKgGptd8DHwY1mXtZ7Aoh4z4yxfwMBue9eNgw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-attribute-case-insensitive/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-calc": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/postcss-calc/-/postcss-calc-9.0.1.tgz", - "integrity": "sha512-TipgjGyzP5QzEhsOZUaIkeO5mKeMFpebWzRogWG/ysonUlnHcq5aJe0jOjpfzUU8PeSaBQnrE8ehR0QA5vs8PQ==", - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^6.0.11", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.2.2" - } - }, - "node_modules/postcss-clamp": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/postcss-clamp/-/postcss-clamp-4.1.0.tgz", - "integrity": "sha512-ry4b1Llo/9zz+PKC+030KUnPITTJAHeOwjfAyyB60eT0AorGLdzp52s31OsPRHRf8NchkgFoG2y6fCfn1IV1Ow==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=7.6.0" - }, - "peerDependencies": { - "postcss": "^8.4.6" - } - }, - "node_modules/postcss-color-functional-notation": { - "version": "7.0.12", - "resolved": "https://registry.npmjs.org/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.12.tgz", - "integrity": "sha512-TLCW9fN5kvO/u38/uesdpbx3e8AkTYhMvDZYa9JpmImWuTE99bDQ7GU7hdOADIZsiI9/zuxfAJxny/khknp1Zw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-color-hex-alpha": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/postcss-color-hex-alpha/-/postcss-color-hex-alpha-10.0.0.tgz", - "integrity": "sha512-1kervM2cnlgPs2a8Vt/Qbe5cQ++N7rkYo/2rz2BkqJZIHQwaVuJgQH38REHrAi4uM0b1fqxMkWYmese94iMp3w==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-color-rebeccapurple": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/postcss-color-rebeccapurple/-/postcss-color-rebeccapurple-10.0.0.tgz", - "integrity": "sha512-JFta737jSP+hdAIEhk1Vs0q0YF5P8fFcj+09pweS8ktuGuZ8pPlykHsk6mPxZ8awDl4TrcxUqJo9l1IhVr/OjQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-colormin": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-colormin/-/postcss-colormin-6.1.0.tgz", - "integrity": "sha512-x9yX7DOxeMAR+BgGVnNSAxmAj98NX/YxEMNFP+SDCEeNLb2r3i6Hh1ksMsnW8Ub5SLCpbescQqn9YEbE9554Sw==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "caniuse-api": "^3.0.0", - "colord": "^2.9.3", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-convert-values": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-convert-values/-/postcss-convert-values-6.1.0.tgz", - "integrity": "sha512-zx8IwP/ts9WvUM6NkVSkiU902QZL1bwPhaVaLynPtCsOTqp+ZKbNi+s6XJg3rfqpKGA/oc7Oxk5t8pOQJcwl/w==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-custom-media": { - "version": "11.0.6", - "resolved": "https://registry.npmjs.org/postcss-custom-media/-/postcss-custom-media-11.0.6.tgz", - "integrity": "sha512-C4lD4b7mUIw+RZhtY7qUbf4eADmb7Ey8BFA2px9jUbwg7pjTZDl4KY4bvlUV+/vXQvzQRfiGEVJyAbtOsCMInw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/cascade-layer-name-parser": "^2.0.5", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/media-query-list-parser": "^4.0.3" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-custom-properties": { - "version": "14.0.6", - "resolved": "https://registry.npmjs.org/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz", - "integrity": "sha512-fTYSp3xuk4BUeVhxCSJdIPhDLpJfNakZKoiTDx7yRGCdlZrSJR7mWKVOBS4sBF+5poPQFMj2YdXx1VHItBGihQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/cascade-layer-name-parser": "^2.0.5", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-custom-selectors": { - "version": "8.0.5", - "resolved": "https://registry.npmjs.org/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz", - "integrity": "sha512-9PGmckHQswiB2usSO6XMSswO2yFWVoCAuih1yl9FVcwkscLjRKjwsjM3t+NIWpSU2Jx3eOiK2+t4vVTQaoCHHg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/cascade-layer-name-parser": "^2.0.5", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-custom-selectors/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-dir-pseudo-class": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/postcss-dir-pseudo-class/-/postcss-dir-pseudo-class-9.0.1.tgz", - "integrity": "sha512-tRBEK0MHYvcMUrAuYMEOa0zg9APqirBcgzi6P21OhxtJyJADo/SWBwY1CAwEohQ/6HDaa9jCjLRG7K3PVQYHEA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-dir-pseudo-class/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-discard-comments": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-discard-comments/-/postcss-discard-comments-6.0.2.tgz", - "integrity": "sha512-65w/uIqhSBBfQmYnG92FO1mWZjJ4GL5b8atm5Yw2UgrwD7HiNiSSNwJor1eCFGzUgYnN/iIknhNRVqjrrpuglw==", - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-discard-duplicates": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-discard-duplicates/-/postcss-discard-duplicates-6.0.3.tgz", - "integrity": "sha512-+JA0DCvc5XvFAxwx6f/e68gQu/7Z9ud584VLmcgto28eB8FqSFZwtrLwB5Kcp70eIoWP/HXqz4wpo8rD8gpsTw==", - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-discard-empty": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-discard-empty/-/postcss-discard-empty-6.0.3.tgz", - "integrity": "sha512-znyno9cHKQsK6PtxL5D19Fj9uwSzC2mB74cpT66fhgOadEUPyXFkbgwm5tvc3bt3NAy8ltE5MrghxovZRVnOjQ==", - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-discard-overridden": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-discard-overridden/-/postcss-discard-overridden-6.0.2.tgz", - "integrity": "sha512-j87xzI4LUggC5zND7KdjsI25APtyMuynXZSujByMaav2roV6OZX+8AaCUcZSWqckZpjAjRyFDdpqybgjFO0HJQ==", - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-discard-unused": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/postcss-discard-unused/-/postcss-discard-unused-6.0.5.tgz", - "integrity": "sha512-wHalBlRHkaNnNwfC8z+ppX57VhvS+HWgjW508esjdaEYr3Mx7Gnn2xA4R/CKf5+Z9S5qsqC+Uzh4ueENWwCVUA==", - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-double-position-gradients": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.4.tgz", - "integrity": "sha512-m6IKmxo7FxSP5nF2l63QbCC3r+bWpFUWmZXZf096WxG0m7Vl1Q1+ruFOhpdDRmKrRS+S3Jtk+TVk/7z0+BVK6g==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-focus-visible": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/postcss-focus-visible/-/postcss-focus-visible-10.0.1.tgz", - "integrity": "sha512-U58wyjS/I1GZgjRok33aE8juW9qQgQUNwTSdxQGuShHzwuYdcklnvK/+qOWX1Q9kr7ysbraQ6ht6r+udansalA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-focus-visible/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-focus-within": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/postcss-focus-within/-/postcss-focus-within-9.0.1.tgz", - "integrity": "sha512-fzNUyS1yOYa7mOjpci/bR+u+ESvdar6hk8XNK/TRR0fiGTp2QT5N+ducP0n3rfH/m9I7H/EQU6lsa2BrgxkEjw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-focus-within/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-font-variant": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/postcss-font-variant/-/postcss-font-variant-5.0.0.tgz", - "integrity": "sha512-1fmkBaCALD72CK2a9i468mA/+tr9/1cBxRRMXOUaZqO43oWPR5imcyPjXwuv7PXbCid4ndlP5zWhidQVVa3hmA==", - "license": "MIT", - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-gap-properties": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/postcss-gap-properties/-/postcss-gap-properties-6.0.0.tgz", - "integrity": "sha512-Om0WPjEwiM9Ru+VhfEDPZJAKWUd0mV1HmNXqp2C29z80aQ2uP9UVhLc7e3aYMIor/S5cVhoPgYQ7RtfeZpYTRw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-image-set-function": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/postcss-image-set-function/-/postcss-image-set-function-7.0.0.tgz", - "integrity": "sha512-QL7W7QNlZuzOwBTeXEmbVckNt1FSmhQtbMRvGGqqU4Nf4xk6KUEQhAoWuMzwbSv5jxiRiSZ5Tv7eiDB9U87znA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-lab-function": { - "version": "7.0.12", - "resolved": "https://registry.npmjs.org/postcss-lab-function/-/postcss-lab-function-7.0.12.tgz", - "integrity": "sha512-tUcyRk1ZTPec3OuKFsqtRzW2Go5lehW29XA21lZ65XmzQkz43VY2tyWEC202F7W3mILOjw0voOiuxRGTsN+J9w==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-loader": { - "version": "7.3.4", - "resolved": "https://registry.npmjs.org/postcss-loader/-/postcss-loader-7.3.4.tgz", - "integrity": "sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A==", - "license": "MIT", - "dependencies": { - "cosmiconfig": "^8.3.5", - "jiti": "^1.20.0", - "semver": "^7.5.4" - }, - "engines": { - "node": ">= 14.15.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "postcss": "^7.0.0 || ^8.0.1", - "webpack": "^5.0.0" - } - }, - "node_modules/postcss-logical": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/postcss-logical/-/postcss-logical-8.1.0.tgz", - "integrity": "sha512-pL1hXFQ2fEXNKiNiAgtfA005T9FBxky5zkX6s4GZM2D8RkVgRqz3f4g1JUoq925zXv495qk8UNldDwh8uGEDoA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-merge-idents": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-merge-idents/-/postcss-merge-idents-6.0.3.tgz", - "integrity": "sha512-1oIoAsODUs6IHQZkLQGO15uGEbK3EAl5wi9SS8hs45VgsxQfMnxvt+L+zIr7ifZFIH14cfAeVe2uCTa+SPRa3g==", - "license": "MIT", - "dependencies": { - "cssnano-utils": "^4.0.2", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-merge-longhand": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/postcss-merge-longhand/-/postcss-merge-longhand-6.0.5.tgz", - "integrity": "sha512-5LOiordeTfi64QhICp07nzzuTDjNSO8g5Ksdibt44d+uvIIAE1oZdRn8y/W5ZtYgRH/lnLDlvi9F8btZcVzu3w==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0", - "stylehacks": "^6.1.1" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-merge-rules": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/postcss-merge-rules/-/postcss-merge-rules-6.1.1.tgz", - "integrity": "sha512-KOdWF0gju31AQPZiD+2Ar9Qjowz1LTChSjFFbS+e2sFgc4uHOp3ZvVX4sNeTlk0w2O31ecFGgrFzhO0RSWbWwQ==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "caniuse-api": "^3.0.0", - "cssnano-utils": "^4.0.2", - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-minify-font-values": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-minify-font-values/-/postcss-minify-font-values-6.1.0.tgz", - "integrity": "sha512-gklfI/n+9rTh8nYaSJXlCo3nOKqMNkxuGpTn/Qm0gstL3ywTr9/WRKznE+oy6fvfolH6dF+QM4nCo8yPLdvGJg==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-minify-gradients": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-minify-gradients/-/postcss-minify-gradients-6.0.3.tgz", - "integrity": "sha512-4KXAHrYlzF0Rr7uc4VrfwDJ2ajrtNEpNEuLxFgwkhFZ56/7gaE4Nr49nLsQDZyUe+ds+kEhf+YAUolJiYXF8+Q==", - "license": "MIT", - "dependencies": { - "colord": "^2.9.3", - "cssnano-utils": "^4.0.2", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-minify-params": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-minify-params/-/postcss-minify-params-6.1.0.tgz", - "integrity": "sha512-bmSKnDtyyE8ujHQK0RQJDIKhQ20Jq1LYiez54WiaOoBtcSuflfK3Nm596LvbtlFcpipMjgClQGyGr7GAs+H1uA==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "cssnano-utils": "^4.0.2", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-minify-selectors": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/postcss-minify-selectors/-/postcss-minify-selectors-6.0.4.tgz", - "integrity": "sha512-L8dZSwNLgK7pjTto9PzWRoMbnLq5vsZSTu8+j1P/2GB8qdtGQfn+K1uSvFgYvgh83cbyxT5m43ZZhUMTJDSClQ==", - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-modules-extract-imports": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/postcss-modules-extract-imports/-/postcss-modules-extract-imports-3.1.0.tgz", - "integrity": "sha512-k3kNe0aNFQDAZGbin48pL2VNidTF0w4/eASDsxlyspobzU3wZQLOGj7L9gfRe0Jo9/4uud09DsjFNH7winGv8Q==", - "license": "ISC", - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-modules-local-by-default": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/postcss-modules-local-by-default/-/postcss-modules-local-by-default-4.2.0.tgz", - "integrity": "sha512-5kcJm/zk+GJDSfw+V/42fJ5fhjL5YbFDl8nVdXkJPLLW+Vf9mTD5Xe0wqIaDnLuL2U6cDNpTr+UQ+v2HWIBhzw==", - "license": "MIT", - "dependencies": { - "icss-utils": "^5.0.0", - "postcss-selector-parser": "^7.0.0", - "postcss-value-parser": "^4.1.0" - }, - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-modules-local-by-default/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-modules-scope": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/postcss-modules-scope/-/postcss-modules-scope-3.2.1.tgz", - "integrity": "sha512-m9jZstCVaqGjTAuny8MdgE88scJnCiQSlSrOWcTQgM2t32UBe+MUmFSO5t7VMSfAf/FJKImAxBav8ooCHJXCJA==", - "license": "ISC", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-modules-scope/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-modules-values": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/postcss-modules-values/-/postcss-modules-values-4.0.0.tgz", - "integrity": "sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ==", - "license": "ISC", - "dependencies": { - "icss-utils": "^5.0.0" - }, - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-nesting": { - "version": "13.0.2", - "resolved": "https://registry.npmjs.org/postcss-nesting/-/postcss-nesting-13.0.2.tgz", - "integrity": "sha512-1YCI290TX+VP0U/K/aFxzHzQWHWURL+CtHMSbex1lCdpXD1SoR2sYuxDu5aNI9lPoXpKTCggFZiDJbwylU0LEQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/selector-resolve-nested": "^3.1.0", - "@csstools/selector-specificity": "^5.0.0", - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-nesting/node_modules/@csstools/selector-resolve-nested": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.1.0.tgz", - "integrity": "sha512-mf1LEW0tJLKfWyvn5KdDrhpxHyuxpbNwTIwOYLIvsTffeyOf85j5oIzfG0yosxDgx/sswlqBnESYUcQH0vgZ0g==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/postcss-nesting/node_modules/@csstools/selector-specificity": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", - "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/postcss-nesting/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-normalize-charset": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-charset/-/postcss-normalize-charset-6.0.2.tgz", - "integrity": "sha512-a8N9czmdnrjPHa3DeFlwqst5eaL5W8jYu3EBbTTkI5FHkfMhFZh1EGbku6jhHhIzTA6tquI2P42NtZ59M/H/kQ==", - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-display-values": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-display-values/-/postcss-normalize-display-values-6.0.2.tgz", - "integrity": "sha512-8H04Mxsb82ON/aAkPeq8kcBbAtI5Q2a64X/mnRRfPXBq7XeogoQvReqxEfc0B4WPq1KimjezNC8flUtC3Qz6jg==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-positions": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-positions/-/postcss-normalize-positions-6.0.2.tgz", - "integrity": "sha512-/JFzI441OAB9O7VnLA+RtSNZvQ0NCFZDOtp6QPFo1iIyawyXg0YI3CYM9HBy1WvwCRHnPep/BvI1+dGPKoXx/Q==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-repeat-style": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-6.0.2.tgz", - "integrity": "sha512-YdCgsfHkJ2jEXwR4RR3Tm/iOxSfdRt7jplS6XRh9Js9PyCR/aka/FCb6TuHT2U8gQubbm/mPmF6L7FY9d79VwQ==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-string": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-string/-/postcss-normalize-string-6.0.2.tgz", - "integrity": "sha512-vQZIivlxlfqqMp4L9PZsFE4YUkWniziKjQWUtsxUiVsSSPelQydwS8Wwcuw0+83ZjPWNTl02oxlIvXsmmG+CiQ==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-timing-functions": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-6.0.2.tgz", - "integrity": "sha512-a+YrtMox4TBtId/AEwbA03VcJgtyW4dGBizPl7e88cTFULYsprgHWTbfyjSLyHeBcK/Q9JhXkt2ZXiwaVHoMzA==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-unicode": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-normalize-unicode/-/postcss-normalize-unicode-6.1.0.tgz", - "integrity": "sha512-QVC5TQHsVj33otj8/JD869Ndr5Xcc/+fwRh4HAsFsAeygQQXm+0PySrKbr/8tkDKzW+EVT3QkqZMfFrGiossDg==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-url": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-url/-/postcss-normalize-url-6.0.2.tgz", - "integrity": "sha512-kVNcWhCeKAzZ8B4pv/DnrU1wNh458zBNp8dh4y5hhxih5RZQ12QWMuQrDgPRw3LRl8mN9vOVfHl7uhvHYMoXsQ==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-whitespace": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-whitespace/-/postcss-normalize-whitespace-6.0.2.tgz", - "integrity": "sha512-sXZ2Nj1icbJOKmdjXVT9pnyHQKiSAyuNQHSgRCUgThn2388Y9cGVDR+E9J9iAYbSbLHI+UUwLVl1Wzco/zgv0Q==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-opacity-percentage": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/postcss-opacity-percentage/-/postcss-opacity-percentage-3.0.0.tgz", - "integrity": "sha512-K6HGVzyxUxd/VgZdX04DCtdwWJ4NGLG212US4/LA1TLAbHgmAsTWVR86o+gGIbFtnTkfOpb9sCRBx8K7HO66qQ==", - "funding": [ - { - "type": "kofi", - "url": "https://ko-fi.com/mrcgrtz" - }, - { - "type": "liberapay", - "url": "https://liberapay.com/mrcgrtz" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-ordered-values": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-ordered-values/-/postcss-ordered-values-6.0.2.tgz", - "integrity": "sha512-VRZSOB+JU32RsEAQrO94QPkClGPKJEL/Z9PCBImXMhIeK5KAYo6slP/hBYlLgrCjFxyqvn5VC81tycFEDBLG1Q==", - "license": "MIT", - "dependencies": { - "cssnano-utils": "^4.0.2", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-overflow-shorthand": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/postcss-overflow-shorthand/-/postcss-overflow-shorthand-6.0.0.tgz", - "integrity": "sha512-BdDl/AbVkDjoTofzDQnwDdm/Ym6oS9KgmO7Gr+LHYjNWJ6ExORe4+3pcLQsLA9gIROMkiGVjjwZNoL/mpXHd5Q==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-page-break": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/postcss-page-break/-/postcss-page-break-3.0.4.tgz", - "integrity": "sha512-1JGu8oCjVXLa9q9rFTo4MbeeA5FMe00/9C7lN4va606Rdb+HkxXtXsmEDrIraQ11fGz/WvKWa8gMuCKkrXpTsQ==", - "license": "MIT", - "peerDependencies": { - "postcss": "^8" - } - }, - "node_modules/postcss-place": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/postcss-place/-/postcss-place-10.0.0.tgz", - "integrity": "sha512-5EBrMzat2pPAxQNWYavwAfoKfYcTADJ8AXGVPcUZ2UkNloUTWzJQExgrzrDkh3EKzmAx1evfTAzF9I8NGcc+qw==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-preset-env": { - "version": "10.6.1", - "resolved": "https://registry.npmjs.org/postcss-preset-env/-/postcss-preset-env-10.6.1.tgz", - "integrity": "sha512-yrk74d9EvY+W7+lO9Aj1QmjWY9q5NsKjK2V9drkOPZB/X6KZ0B3igKsHUYakb7oYVhnioWypQX3xGuePf89f3g==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/postcss-alpha-function": "^1.0.1", - "@csstools/postcss-cascade-layers": "^5.0.2", - "@csstools/postcss-color-function": "^4.0.12", - "@csstools/postcss-color-function-display-p3-linear": "^1.0.1", - "@csstools/postcss-color-mix-function": "^3.0.12", - "@csstools/postcss-color-mix-variadic-function-arguments": "^1.0.2", - "@csstools/postcss-content-alt-text": "^2.0.8", - "@csstools/postcss-contrast-color-function": "^2.0.12", - "@csstools/postcss-exponential-functions": "^2.0.9", - "@csstools/postcss-font-format-keywords": "^4.0.0", - "@csstools/postcss-gamut-mapping": "^2.0.11", - "@csstools/postcss-gradients-interpolation-method": "^5.0.12", - "@csstools/postcss-hwb-function": "^4.0.12", - "@csstools/postcss-ic-unit": "^4.0.4", - "@csstools/postcss-initial": "^2.0.1", - "@csstools/postcss-is-pseudo-class": "^5.0.3", - "@csstools/postcss-light-dark-function": "^2.0.11", - "@csstools/postcss-logical-float-and-clear": "^3.0.0", - "@csstools/postcss-logical-overflow": "^2.0.0", - "@csstools/postcss-logical-overscroll-behavior": "^2.0.0", - "@csstools/postcss-logical-resize": "^3.0.0", - "@csstools/postcss-logical-viewport-units": "^3.0.4", - "@csstools/postcss-media-minmax": "^2.0.9", - "@csstools/postcss-media-queries-aspect-ratio-number-values": "^3.0.5", - "@csstools/postcss-nested-calc": "^4.0.0", - "@csstools/postcss-normalize-display-values": "^4.0.1", - "@csstools/postcss-oklab-function": "^4.0.12", - "@csstools/postcss-position-area-property": "^1.0.0", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/postcss-property-rule-prelude-list": "^1.0.0", - "@csstools/postcss-random-function": "^2.0.1", - "@csstools/postcss-relative-color-syntax": "^3.0.12", - "@csstools/postcss-scope-pseudo-class": "^4.0.1", - "@csstools/postcss-sign-functions": "^1.1.4", - "@csstools/postcss-stepped-value-functions": "^4.0.9", - "@csstools/postcss-syntax-descriptor-syntax-production": "^1.0.1", - "@csstools/postcss-system-ui-font-family": "^1.0.0", - "@csstools/postcss-text-decoration-shorthand": "^4.0.3", - "@csstools/postcss-trigonometric-functions": "^4.0.9", - "@csstools/postcss-unset-value": "^4.0.0", - "autoprefixer": "^10.4.23", - "browserslist": "^4.28.1", - "css-blank-pseudo": "^7.0.1", - "css-has-pseudo": "^7.0.3", - "css-prefers-color-scheme": "^10.0.0", - "cssdb": "^8.6.0", - "postcss-attribute-case-insensitive": "^7.0.1", - "postcss-clamp": "^4.1.0", - "postcss-color-functional-notation": "^7.0.12", - "postcss-color-hex-alpha": "^10.0.0", - "postcss-color-rebeccapurple": "^10.0.0", - "postcss-custom-media": "^11.0.6", - "postcss-custom-properties": "^14.0.6", - "postcss-custom-selectors": "^8.0.5", - "postcss-dir-pseudo-class": "^9.0.1", - "postcss-double-position-gradients": "^6.0.4", - "postcss-focus-visible": "^10.0.1", - "postcss-focus-within": "^9.0.1", - "postcss-font-variant": "^5.0.0", - "postcss-gap-properties": "^6.0.0", - "postcss-image-set-function": "^7.0.0", - "postcss-lab-function": "^7.0.12", - "postcss-logical": "^8.1.0", - "postcss-nesting": "^13.0.2", - "postcss-opacity-percentage": "^3.0.0", - "postcss-overflow-shorthand": "^6.0.0", - "postcss-page-break": "^3.0.4", - "postcss-place": "^10.0.0", - "postcss-pseudo-class-any-link": "^10.0.1", - "postcss-replace-overflow-wrap": "^4.0.0", - "postcss-selector-not": "^8.0.1" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-pseudo-class-any-link": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/postcss-pseudo-class-any-link/-/postcss-pseudo-class-any-link-10.0.1.tgz", - "integrity": "sha512-3el9rXlBOqTFaMFkWDOkHUTQekFIYnaQY55Rsp8As8QQkpiSgIYEcF/6Ond93oHiDsGb4kad8zjt+NPlOC1H0Q==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-pseudo-class-any-link/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-reduce-idents": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-reduce-idents/-/postcss-reduce-idents-6.0.3.tgz", - "integrity": "sha512-G3yCqZDpsNPoQgbDUy3T0E6hqOQ5xigUtBQyrmq3tn2GxlyiL0yyl7H+T8ulQR6kOcHJ9t7/9H4/R2tv8tJbMA==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-reduce-initial": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-reduce-initial/-/postcss-reduce-initial-6.1.0.tgz", - "integrity": "sha512-RarLgBK/CrL1qZags04oKbVbrrVK2wcxhvta3GCxrZO4zveibqbRPmm2VI8sSgCXwoUHEliRSbOfpR0b/VIoiw==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "caniuse-api": "^3.0.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-reduce-transforms": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-reduce-transforms/-/postcss-reduce-transforms-6.0.2.tgz", - "integrity": "sha512-sB+Ya++3Xj1WaT9+5LOOdirAxP7dJZms3GRcYheSPi1PiTMigsxHAdkrbItHxwYHr4kt1zL7mmcHstgMYT+aiA==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-replace-overflow-wrap": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/postcss-replace-overflow-wrap/-/postcss-replace-overflow-wrap-4.0.0.tgz", - "integrity": "sha512-KmF7SBPphT4gPPcKZc7aDkweHiKEEO8cla/GjcBK+ckKxiZslIu3C4GCRW3DNfL0o7yW7kMQu9xlZ1kXRXLXtw==", - "license": "MIT", - "peerDependencies": { - "postcss": "^8.0.3" - } - }, - "node_modules/postcss-selector-not": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/postcss-selector-not/-/postcss-selector-not-8.0.1.tgz", - "integrity": "sha512-kmVy/5PYVb2UOhy0+LqUYAhKj7DUGDpSWa5LZqlkWJaaAV+dxxsOG3+St0yNLu6vsKD7Dmqx+nWQt0iil89+WA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-selector-not/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-selector-parser": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz", - "integrity": "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg==", - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-sort-media-queries": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/postcss-sort-media-queries/-/postcss-sort-media-queries-5.2.0.tgz", - "integrity": "sha512-AZ5fDMLD8SldlAYlvi8NIqo0+Z8xnXU2ia0jxmuhxAU+Lqt9K+AlmLNJ/zWEnE9x+Zx3qL3+1K20ATgNOr3fAA==", - "license": "MIT", - "dependencies": { - "sort-css-media-queries": "2.2.0" - }, - "engines": { - "node": ">=14.0.0" - }, - "peerDependencies": { - "postcss": "^8.4.23" - } - }, - "node_modules/postcss-svgo": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-svgo/-/postcss-svgo-6.0.3.tgz", - "integrity": "sha512-dlrahRmxP22bX6iKEjOM+c8/1p+81asjKT+V5lrgOH944ryx/OHpclnIbGsKVd3uWOXFLYJwCVf0eEkJGvO96g==", - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0", - "svgo": "^3.2.0" - }, - "engines": { - "node": "^14 || ^16 || >= 18" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-unique-selectors": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/postcss-unique-selectors/-/postcss-unique-selectors-6.0.4.tgz", - "integrity": "sha512-K38OCaIrO8+PzpArzkLKB42dSARtC2tmG6PvD4b1o1Q2E9Os8jzfWFfSy/rixsHwohtsDdFtAWGjFVFUdwYaMg==", - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-value-parser": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz", - "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==", - "license": "MIT" - }, - "node_modules/postcss-zindex": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-zindex/-/postcss-zindex-6.0.2.tgz", - "integrity": "sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg==", - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/pretty-error": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz", - "integrity": "sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw==", - "license": "MIT", - "dependencies": { - "lodash": "^4.17.20", - "renderkid": "^3.0.0" - } - }, - "node_modules/pretty-time": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/pretty-time/-/pretty-time-1.1.0.tgz", - "integrity": "sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/prism-react-renderer": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/prism-react-renderer/-/prism-react-renderer-2.4.1.tgz", - "integrity": "sha512-ey8Ls/+Di31eqzUxC46h8MksNuGx/n0AAC8uKpwFau4RPDYLuE3EXTp8N8G2vX2N7UC/+IXeNUnlWBGGcAG+Ig==", - "license": "MIT", - "dependencies": { - "@types/prismjs": "^1.26.0", - "clsx": "^2.0.0" - }, - "peerDependencies": { - "react": ">=16.0.0" - } - }, - "node_modules/prismjs": { - "version": "1.30.0", - "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.30.0.tgz", - "integrity": "sha512-DEvV2ZF2r2/63V+tK8hQvrR2ZGn10srHbXviTlcv7Kpzw8jWiNTqbVgjO3IY8RxrrOUF8VPMQQFysYYYv0YZxw==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/process-nextick-args": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", - "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", - "license": "MIT" - }, - "node_modules/prompts": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", - "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", - "license": "MIT", - "dependencies": { - "kleur": "^3.0.3", - "sisteransi": "^1.0.5" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/prop-types": { - "version": "15.8.1", - "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", - "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", - "license": "MIT", - "dependencies": { - "loose-envify": "^1.4.0", - "object-assign": "^4.1.1", - "react-is": "^16.13.1" - } - }, - "node_modules/property-information": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/property-information/-/property-information-7.1.0.tgz", - "integrity": "sha512-TwEZ+X+yCJmYfL7TPUOcvBZ4QfoT5YenQiJuX//0th53DE6w0xxLEtfK3iyryQFddXuvkIk51EEgrJQ0WJkOmQ==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/proto-list": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", - "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", - "license": "ISC" - }, - "node_modules/proxy-addr": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", - "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", - "license": "MIT", - "dependencies": { - "forwarded": "0.2.0", - "ipaddr.js": "1.9.1" - }, - "engines": { - "node": ">= 0.10" - } - }, - "node_modules/proxy-addr/node_modules/ipaddr.js": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", - "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", - "license": "MIT", - "engines": { - "node": ">= 0.10" - } - }, - "node_modules/punycode": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", - "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/punycode.js": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", - "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/pupa": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.3.0.tgz", - "integrity": "sha512-LjgDO2zPtoXP2wJpDjZrGdojii1uqO0cnwKoIoUzkfS98HDmbeiGmYiXo3lXeFlq2xvne1QFQhwYXSUCLKtEuA==", - "license": "MIT", - "dependencies": { - "escape-goat": "^4.0.0" - }, - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pvtsutils": { - "version": "1.3.6", - "resolved": "https://registry.npmjs.org/pvtsutils/-/pvtsutils-1.3.6.tgz", - "integrity": "sha512-PLgQXQ6H2FWCaeRak8vvk1GW462lMxB5s3Jm673N82zI4vqtVUPuZdffdZbPDFRoU8kAhItWFtPCWiPpp4/EDg==", - "license": "MIT", - "dependencies": { - "tslib": "^2.8.1" - } - }, - "node_modules/pvutils": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/pvutils/-/pvutils-1.1.5.tgz", - "integrity": "sha512-KTqnxsgGiQ6ZAzZCVlJH5eOjSnvlyEgx1m8bkRJfOhmGRqfo5KLvmAlACQkrjEtOQ4B7wF9TdSLIs9O90MX9xA==", - "license": "MIT", - "engines": { - "node": ">=16.0.0" - } - }, - "node_modules/qs": { - "version": "6.14.2", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.2.tgz", - "integrity": "sha512-V/yCWTTF7VJ9hIh18Ugr2zhJMP01MY7c5kh4J870L7imm6/DIzBsNLTXzMwUA3yZ5b/KBqLx8Kp3uRvd7xSe3Q==", - "license": "BSD-3-Clause", - "dependencies": { - "side-channel": "^1.1.0" - }, - "engines": { - "node": ">=0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/queue-microtask": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/quick-lru": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz", - "integrity": "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/randombytes": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", - "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", - "license": "MIT", - "dependencies": { - "safe-buffer": "^5.1.0" - } - }, - "node_modules/range-parser": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz", - "integrity": "sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/raw-body": { - "version": "2.5.3", - "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.3.tgz", - "integrity": "sha512-s4VSOf6yN0rvbRZGxs8Om5CWj6seneMwK3oDb4lWDH0UPhWcxwOWw5+qk24bxq87szX1ydrwylIOp2uG1ojUpA==", - "license": "MIT", - "dependencies": { - "bytes": "~3.1.2", - "http-errors": "~2.0.1", - "iconv-lite": "~0.4.24", - "unpipe": "~1.0.0" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/raw-body/node_modules/bytes": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", - "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/rc": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", - "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", - "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", - "dependencies": { - "deep-extend": "^0.6.0", - "ini": "~1.3.0", - "minimist": "^1.2.0", - "strip-json-comments": "~2.0.1" - }, - "bin": { - "rc": "cli.js" - } - }, - "node_modules/rc/node_modules/ini": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", - "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", - "license": "ISC" - }, - "node_modules/rc/node_modules/strip-json-comments": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/react": { - "version": "19.2.4", - "resolved": "https://registry.npmjs.org/react/-/react-19.2.4.tgz", - "integrity": "sha512-9nfp2hYpCwOjAN+8TZFGhtWEwgvWHXqESH8qT89AT/lWklpLON22Lc8pEtnpsZz7VmawabSU0gCjnj8aC0euHQ==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/react-dom": { - "version": "19.2.4", - "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.4.tgz", - "integrity": "sha512-AXJdLo8kgMbimY95O2aKQqsz2iWi9jMgKJhRBAxECE4IFxfcazB2LmzloIoibJI3C12IlY20+KFaLv+71bUJeQ==", - "license": "MIT", - "dependencies": { - "scheduler": "^0.27.0" - }, - "peerDependencies": { - "react": "^19.2.4" - } - }, - "node_modules/react-fast-compare": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/react-fast-compare/-/react-fast-compare-3.2.2.tgz", - "integrity": "sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ==", - "license": "MIT" - }, - "node_modules/react-helmet-async": { - "name": "@slorber/react-helmet-async", - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz", - "integrity": "sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A==", - "license": "Apache-2.0", - "dependencies": { - "@babel/runtime": "^7.12.5", - "invariant": "^2.2.4", - "prop-types": "^15.7.2", - "react-fast-compare": "^3.2.0", - "shallowequal": "^1.1.0" - }, - "peerDependencies": { - "react": "^16.6.0 || ^17.0.0 || ^18.0.0 || ^19.0.0", - "react-dom": "^16.6.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" - } - }, - "node_modules/react-is": { - "version": "16.13.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", - "license": "MIT" - }, - "node_modules/react-json-view-lite": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz", - "integrity": "sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g==", - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/react-loadable": { - "name": "@docusaurus/react-loadable", - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", - "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", - "license": "MIT", - "dependencies": { - "@types/react": "*" - }, - "peerDependencies": { - "react": "*" - } - }, - "node_modules/react-loadable-ssr-addon-v5-slorber": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.3.tgz", - "integrity": "sha512-GXfh9VLwB5ERaCsU6RULh7tkemeX15aNh6wuMEBtfdyMa7fFG8TXrhXlx1SoEK2Ty/l6XIkzzYIQmyaWW3JgdQ==", - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.10.3" - }, - "engines": { - "node": ">=10.13.0" - }, - "peerDependencies": { - "react-loadable": "*", - "webpack": ">=4.41.1 || 5.x" - } - }, - "node_modules/react-router": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", - "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.12.13", - "history": "^4.9.0", - "hoist-non-react-statics": "^3.1.0", - "loose-envify": "^1.3.1", - "path-to-regexp": "^1.7.0", - "prop-types": "^15.6.2", - "react-is": "^16.6.0", - "tiny-invariant": "^1.0.2", - "tiny-warning": "^1.0.0" - }, - "peerDependencies": { - "react": ">=15" - } - }, - "node_modules/react-router-config": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/react-router-config/-/react-router-config-5.1.1.tgz", - "integrity": "sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg==", - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.1.2" - }, - "peerDependencies": { - "react": ">=15", - "react-router": ">=5" - } - }, - "node_modules/react-router-dom": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-5.3.4.tgz", - "integrity": "sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ==", - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.12.13", - "history": "^4.9.0", - "loose-envify": "^1.3.1", - "prop-types": "^15.6.2", - "react-router": "5.3.4", - "tiny-invariant": "^1.0.2", - "tiny-warning": "^1.0.0" - }, - "peerDependencies": { - "react": ">=15" - } - }, - "node_modules/readable-stream": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", - "license": "MIT", - "dependencies": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/readdirp": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", - "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", - "license": "MIT", - "dependencies": { - "picomatch": "^2.2.1" - }, - "engines": { - "node": ">=8.10.0" - } - }, - "node_modules/recma-build-jsx": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/recma-build-jsx/-/recma-build-jsx-1.0.0.tgz", - "integrity": "sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "estree-util-build-jsx": "^3.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/recma-jsx": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/recma-jsx/-/recma-jsx-1.0.1.tgz", - "integrity": "sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w==", - "license": "MIT", - "dependencies": { - "acorn-jsx": "^5.0.0", - "estree-util-to-js": "^2.0.0", - "recma-parse": "^1.0.0", - "recma-stringify": "^1.0.0", - "unified": "^11.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - }, - "peerDependencies": { - "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" - } - }, - "node_modules/recma-parse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/recma-parse/-/recma-parse-1.0.0.tgz", - "integrity": "sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "esast-util-from-js": "^2.0.0", - "unified": "^11.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/recma-stringify": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/recma-stringify/-/recma-stringify-1.0.0.tgz", - "integrity": "sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "estree-util-to-js": "^2.0.0", - "unified": "^11.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/reflect-metadata": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz", - "integrity": "sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q==", - "license": "Apache-2.0" - }, - "node_modules/regenerate": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", - "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", - "license": "MIT" - }, - "node_modules/regenerate-unicode-properties": { - "version": "10.2.2", - "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz", - "integrity": "sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g==", - "license": "MIT", - "dependencies": { - "regenerate": "^1.4.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/regexpu-core": { - "version": "6.4.0", - "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.4.0.tgz", - "integrity": "sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA==", - "license": "MIT", - "dependencies": { - "regenerate": "^1.4.2", - "regenerate-unicode-properties": "^10.2.2", - "regjsgen": "^0.8.0", - "regjsparser": "^0.13.0", - "unicode-match-property-ecmascript": "^2.0.0", - "unicode-match-property-value-ecmascript": "^2.2.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/registry-auth-token": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.1.1.tgz", - "integrity": "sha512-P7B4+jq8DeD2nMsAcdfaqHbssgHtZ7Z5+++a5ask90fvmJ8p5je4mOa+wzu+DB4vQ5tdJV/xywY+UnVFeQLV5Q==", - "license": "MIT", - "dependencies": { - "@pnpm/npm-conf": "^3.0.2" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/registry-url": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", - "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", - "license": "MIT", - "dependencies": { - "rc": "1.2.8" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/regjsgen": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/regjsgen/-/regjsgen-0.8.0.tgz", - "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==", - "license": "MIT" - }, - "node_modules/regjsparser": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.0.tgz", - "integrity": "sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q==", - "license": "BSD-2-Clause", - "dependencies": { - "jsesc": "~3.1.0" - }, - "bin": { - "regjsparser": "bin/parser" - } - }, - "node_modules/rehype-raw": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/rehype-raw/-/rehype-raw-7.0.0.tgz", - "integrity": "sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0", - "hast-util-raw": "^9.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/rehype-recma": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/rehype-recma/-/rehype-recma-1.0.0.tgz", - "integrity": "sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw==", - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0", - "@types/hast": "^3.0.0", - "hast-util-to-estree": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/relateurl": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/relateurl/-/relateurl-0.2.7.tgz", - "integrity": "sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog==", - "license": "MIT", - "engines": { - "node": ">= 0.10" - } - }, - "node_modules/remark-directive": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/remark-directive/-/remark-directive-3.0.1.tgz", - "integrity": "sha512-gwglrEQEZcZYgVyG1tQuA+h58EZfq5CSULw7J90AFuCTyib1thgHPoqQ+h9iFvU6R+vnZ5oNFQR5QKgGpk741A==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "mdast-util-directive": "^3.0.0", - "micromark-extension-directive": "^3.0.0", - "unified": "^11.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/remark-emoji": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/remark-emoji/-/remark-emoji-4.0.1.tgz", - "integrity": "sha512-fHdvsTR1dHkWKev9eNyhTo4EFwbUvJ8ka9SgeWkMPYFX4WoI7ViVBms3PjlQYgw5TLvNQso3GUB/b/8t3yo+dg==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.2", - "emoticon": "^4.0.1", - "mdast-util-find-and-replace": "^3.0.1", - "node-emoji": "^2.1.0", - "unified": "^11.0.4" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - } - }, - "node_modules/remark-frontmatter": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-5.0.0.tgz", - "integrity": "sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "mdast-util-frontmatter": "^2.0.0", - "micromark-extension-frontmatter": "^2.0.0", - "unified": "^11.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/remark-gfm": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/remark-gfm/-/remark-gfm-4.0.1.tgz", - "integrity": "sha512-1quofZ2RQ9EWdeN34S79+KExV1764+wCUGop5CPL1WGdD0ocPpu91lzPGbwWMECpEpd42kJGQwzRfyov9j4yNg==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "mdast-util-gfm": "^3.0.0", - "micromark-extension-gfm": "^3.0.0", - "remark-parse": "^11.0.0", - "remark-stringify": "^11.0.0", - "unified": "^11.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/remark-mdx": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/remark-mdx/-/remark-mdx-3.1.1.tgz", - "integrity": "sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg==", - "license": "MIT", - "dependencies": { - "mdast-util-mdx": "^3.0.0", - "micromark-extension-mdxjs": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/remark-parse": { - "version": "11.0.0", - "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-11.0.0.tgz", - "integrity": "sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "mdast-util-from-markdown": "^2.0.0", - "micromark-util-types": "^2.0.0", - "unified": "^11.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/remark-rehype": { - "version": "11.1.2", - "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-11.1.2.tgz", - "integrity": "sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw==", - "license": "MIT", - "dependencies": { - "@types/hast": "^3.0.0", - "@types/mdast": "^4.0.0", - "mdast-util-to-hast": "^13.0.0", - "unified": "^11.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/remark-stringify": { - "version": "11.0.0", - "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-11.0.0.tgz", - "integrity": "sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw==", - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "mdast-util-to-markdown": "^2.0.0", - "unified": "^11.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/renderkid": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/renderkid/-/renderkid-3.0.0.tgz", - "integrity": "sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg==", - "license": "MIT", - "dependencies": { - "css-select": "^4.1.3", - "dom-converter": "^0.2.0", - "htmlparser2": "^6.1.0", - "lodash": "^4.17.21", - "strip-ansi": "^6.0.1" - } - }, - "node_modules/renderkid/node_modules/css-select": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/css-select/-/css-select-4.3.0.tgz", - "integrity": "sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==", - "license": "BSD-2-Clause", - "dependencies": { - "boolbase": "^1.0.0", - "css-what": "^6.0.1", - "domhandler": "^4.3.1", - "domutils": "^2.8.0", - "nth-check": "^2.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, - "node_modules/renderkid/node_modules/dom-serializer": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.4.1.tgz", - "integrity": "sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==", - "license": "MIT", - "dependencies": { - "domelementtype": "^2.0.1", - "domhandler": "^4.2.0", - "entities": "^2.0.0" - }, - "funding": { - "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" - } - }, - "node_modules/renderkid/node_modules/domhandler": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.3.1.tgz", - "integrity": "sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==", - "license": "BSD-2-Clause", - "dependencies": { - "domelementtype": "^2.2.0" - }, - "engines": { - "node": ">= 4" - }, - "funding": { - "url": "https://github.com/fb55/domhandler?sponsor=1" - } - }, - "node_modules/renderkid/node_modules/domutils": { - "version": "2.8.0", - "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", - "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", - "license": "BSD-2-Clause", - "dependencies": { - "dom-serializer": "^1.0.1", - "domelementtype": "^2.2.0", - "domhandler": "^4.2.0" - }, - "funding": { - "url": "https://github.com/fb55/domutils?sponsor=1" - } - }, - "node_modules/renderkid/node_modules/entities": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", - "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", - "license": "BSD-2-Clause", - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, - "node_modules/renderkid/node_modules/htmlparser2": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz", - "integrity": "sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==", - "funding": [ - "https://github.com/fb55/htmlparser2?sponsor=1", - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ], - "license": "MIT", - "dependencies": { - "domelementtype": "^2.0.1", - "domhandler": "^4.0.0", - "domutils": "^2.5.2", - "entities": "^2.0.0" - } - }, - "node_modules/repeat-string": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==", - "license": "MIT", - "engines": { - "node": ">=0.10" - } - }, - "node_modules/require-from-string": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", - "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/require-like": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/require-like/-/require-like-0.1.2.tgz", - "integrity": "sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A==", - "engines": { - "node": "*" - } - }, - "node_modules/requires-port": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", - "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", - "license": "MIT" - }, - "node_modules/resolve": { - "version": "1.22.11", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", - "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", - "license": "MIT", - "dependencies": { - "is-core-module": "^2.16.1", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" - }, - "bin": { - "resolve": "bin/resolve" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/resolve-alpn": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", - "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==", - "license": "MIT" - }, - "node_modules/resolve-from": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/resolve-pathname": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz", - "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==", - "license": "MIT" - }, - "node_modules/responselike": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/responselike/-/responselike-3.0.0.tgz", - "integrity": "sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg==", - "license": "MIT", - "dependencies": { - "lowercase-keys": "^3.0.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/retry": { - "version": "0.13.1", - "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", - "integrity": "sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==", - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/reusify": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", - "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", - "license": "MIT", - "engines": { - "iojs": ">=1.0.0", - "node": ">=0.10.0" - } - }, - "node_modules/rtlcss": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/rtlcss/-/rtlcss-4.3.0.tgz", - "integrity": "sha512-FI+pHEn7Wc4NqKXMXFM+VAYKEj/mRIcW4h24YVwVtyjI+EqGrLc2Hx/Ny0lrZ21cBWU2goLy36eqMcNj3AQJig==", - "license": "MIT", - "dependencies": { - "escalade": "^3.1.1", - "picocolors": "^1.0.0", - "postcss": "^8.4.21", - "strip-json-comments": "^3.1.1" - }, - "bin": { - "rtlcss": "bin/rtlcss.js" - }, - "engines": { - "node": ">=12.0.0" - } - }, - "node_modules/run-applescript": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/run-applescript/-/run-applescript-7.1.0.tgz", - "integrity": "sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q==", - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/run-parallel": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "queue-microtask": "^1.2.2" - } - }, - "node_modules/safe-buffer": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", - "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/safer-buffer": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", - "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", - "license": "MIT" - }, - "node_modules/sax": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/sax/-/sax-1.6.0.tgz", - "integrity": "sha512-6R3J5M4AcbtLUdZmRv2SygeVaM7IhrLXu9BmnOGmmACak8fiUtOsYNWUS4uK7upbmHIBbLBeFeI//477BKLBzA==", - "license": "BlueOak-1.0.0", - "engines": { - "node": ">=11.0.0" - } - }, - "node_modules/scheduler": { - "version": "0.27.0", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.27.0.tgz", - "integrity": "sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q==", - "license": "MIT" - }, - "node_modules/schema-dts": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/schema-dts/-/schema-dts-1.1.5.tgz", - "integrity": "sha512-RJr9EaCmsLzBX2NDiO5Z3ux2BVosNZN5jo0gWgsyKvxKIUL5R3swNvoorulAeL9kLB0iTSX7V6aokhla2m7xbg==", - "license": "Apache-2.0" - }, - "node_modules/schema-utils": { - "version": "4.3.3", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-4.3.3.tgz", - "integrity": "sha512-eflK8wEtyOE6+hsaRVPxvUKYCpRgzLqDTb8krvAsRIwOGlHoSgYLgBXoubGgLd2fT41/OUYdb48v4k4WWHQurA==", - "license": "MIT", - "dependencies": { - "@types/json-schema": "^7.0.9", - "ajv": "^8.9.0", - "ajv-formats": "^2.1.1", - "ajv-keywords": "^5.1.0" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/search-insights": { - "version": "2.17.3", - "resolved": "https://registry.npmjs.org/search-insights/-/search-insights-2.17.3.tgz", - "integrity": "sha512-RQPdCYTa8A68uM2jwxoY842xDhvx3E5LFL1LxvxCNMev4o5mLuokczhzjAgGwUZBAmOKZknArSxLKmXtIi2AxQ==", - "license": "MIT", - "peer": true - }, - "node_modules/section-matter": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz", - "integrity": "sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==", - "license": "MIT", - "dependencies": { - "extend-shallow": "^2.0.1", - "kind-of": "^6.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/select-hose": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/select-hose/-/select-hose-2.0.0.tgz", - "integrity": "sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg==", - "license": "MIT" - }, - "node_modules/selfsigned": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/selfsigned/-/selfsigned-5.5.0.tgz", - "integrity": "sha512-ftnu3TW4+3eBfLRFnDEkzGxSF/10BJBkaLJuBHZX0kiPS7bRdlpZGu6YGt4KngMkdTwJE6MbjavFpqHvqVt+Ew==", - "license": "MIT", - "dependencies": { - "@peculiar/x509": "^1.14.2", - "pkijs": "^3.3.3" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/semver-diff": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", - "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", - "license": "MIT", - "dependencies": { - "semver": "^7.3.5" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/send": { - "version": "0.19.2", - "resolved": "https://registry.npmjs.org/send/-/send-0.19.2.tgz", - "integrity": "sha512-VMbMxbDeehAxpOtWJXlcUS5E8iXh6QmN+BkRX1GARS3wRaXEEgzCcB10gTQazO42tpNIya8xIyNx8fll1OFPrg==", - "license": "MIT", - "dependencies": { - "debug": "2.6.9", - "depd": "2.0.0", - "destroy": "1.2.0", - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "etag": "~1.8.1", - "fresh": "~0.5.2", - "http-errors": "~2.0.1", - "mime": "1.6.0", - "ms": "2.1.3", - "on-finished": "~2.4.1", - "range-parser": "~1.2.1", - "statuses": "~2.0.2" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/send/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/send/node_modules/debug/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "license": "MIT" - }, - "node_modules/send/node_modules/range-parser": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", - "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serialize-javascript": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", - "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", - "license": "BSD-3-Clause", - "dependencies": { - "randombytes": "^2.1.0" - } - }, - "node_modules/serve-handler": { - "version": "6.1.7", - "resolved": "https://registry.npmjs.org/serve-handler/-/serve-handler-6.1.7.tgz", - "integrity": "sha512-CinAq1xWb0vR3twAv9evEU8cNWkXCb9kd5ePAHUKJBkOsUpR1wt/CvGdeca7vqumL1U5cSaeVQ6zZMxiJ3yWsg==", - "license": "MIT", - "dependencies": { - "bytes": "3.0.0", - "content-disposition": "0.5.2", - "mime-types": "2.1.18", - "minimatch": "3.1.5", - "path-is-inside": "1.0.2", - "path-to-regexp": "3.3.0", - "range-parser": "1.2.0" - } - }, - "node_modules/serve-handler/node_modules/path-to-regexp": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-3.3.0.tgz", - "integrity": "sha512-qyCH421YQPS2WFDxDjftfc1ZR5WKQzVzqsp4n9M2kQhVOo/ByahFoUNJfl58kOcEGfQ//7weFTDhm+ss8Ecxgw==", - "license": "MIT" - }, - "node_modules/serve-index": { - "version": "1.9.2", - "resolved": "https://registry.npmjs.org/serve-index/-/serve-index-1.9.2.tgz", - "integrity": "sha512-KDj11HScOaLmrPxl70KYNW1PksP4Nb/CLL2yvC+Qd2kHMPEEpfc4Re2e4FOay+bC/+XQl/7zAcWON3JVo5v3KQ==", - "license": "MIT", - "dependencies": { - "accepts": "~1.3.8", - "batch": "0.6.1", - "debug": "2.6.9", - "escape-html": "~1.0.3", - "http-errors": "~1.8.0", - "mime-types": "~2.1.35", - "parseurl": "~1.3.3" - }, - "engines": { - "node": ">= 0.8.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/express" - } - }, - "node_modules/serve-index/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/serve-index/node_modules/depd": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", - "integrity": "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serve-index/node_modules/http-errors": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.8.1.tgz", - "integrity": "sha512-Kpk9Sm7NmI+RHhnj6OIWDI1d6fIoFAtFt9RLaTMRlg/8w49juAStsrBgp0Dp4OdxdVbRIeKhtCUvoi/RuAhO4g==", - "license": "MIT", - "dependencies": { - "depd": "~1.1.2", - "inherits": "2.0.4", - "setprototypeof": "1.2.0", - "statuses": ">= 1.5.0 < 2", - "toidentifier": "1.0.1" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serve-index/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serve-index/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serve-index/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "license": "MIT" - }, - "node_modules/serve-index/node_modules/statuses": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", - "integrity": "sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serve-static": { - "version": "1.16.3", - "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.3.tgz", - "integrity": "sha512-x0RTqQel6g5SY7Lg6ZreMmsOzncHFU7nhnRWkKgWuMTu5NN0DR5oruckMqRvacAN9d5w6ARnRBXl9xhDCgfMeA==", - "license": "MIT", - "dependencies": { - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "parseurl": "~1.3.3", - "send": "~0.19.1" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/set-function-length": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", - "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", - "license": "MIT", - "dependencies": { - "define-data-property": "^1.1.4", - "es-errors": "^1.3.0", - "function-bind": "^1.1.2", - "get-intrinsic": "^1.2.4", - "gopd": "^1.0.1", - "has-property-descriptors": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/setprototypeof": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", - "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", - "license": "ISC" - }, - "node_modules/shallow-clone": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", - "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", - "license": "MIT", - "dependencies": { - "kind-of": "^6.0.2" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shallowequal": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz", - "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==", - "license": "MIT" - }, - "node_modules/shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "license": "MIT", - "dependencies": { - "shebang-regex": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/shell-quote": { - "version": "1.8.3", - "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.3.tgz", - "integrity": "sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/side-channel": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", - "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", - "license": "MIT", - "dependencies": { - "es-errors": "^1.3.0", - "object-inspect": "^1.13.3", - "side-channel-list": "^1.0.0", - "side-channel-map": "^1.0.1", - "side-channel-weakmap": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/side-channel-list": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", - "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", - "license": "MIT", - "dependencies": { - "es-errors": "^1.3.0", - "object-inspect": "^1.13.3" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/side-channel-map": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", - "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", - "license": "MIT", - "dependencies": { - "call-bound": "^1.0.2", - "es-errors": "^1.3.0", - "get-intrinsic": "^1.2.5", - "object-inspect": "^1.13.3" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/side-channel-weakmap": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", - "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", - "license": "MIT", - "dependencies": { - "call-bound": "^1.0.2", - "es-errors": "^1.3.0", - "get-intrinsic": "^1.2.5", - "object-inspect": "^1.13.3", - "side-channel-map": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/signal-exit": { - "version": "3.0.7", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", - "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", - "license": "ISC" - }, - "node_modules/sirv": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/sirv/-/sirv-2.0.4.tgz", - "integrity": "sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==", - "license": "MIT", - "dependencies": { - "@polka/url": "^1.0.0-next.24", - "mrmime": "^2.0.0", - "totalist": "^3.0.0" - }, - "engines": { - "node": ">= 10" - } - }, - "node_modules/sisteransi": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", - "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", - "license": "MIT" - }, - "node_modules/sitemap": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/sitemap/-/sitemap-7.1.3.tgz", - "integrity": "sha512-tAjEd+wt/YwnEbfNB2ht51ybBJxbEWwe5ki/Z//Wh0rpBFTCUSj46GnxUKEWzhfuJTsee8x3lybHxFgUMig2hw==", - "license": "MIT", - "dependencies": { - "@types/node": "^17.0.5", - "@types/sax": "^1.2.1", - "arg": "^5.0.0", - "sax": "^1.2.4" - }, - "bin": { - "sitemap": "dist/cli.js" - }, - "engines": { - "node": ">=12.0.0", - "npm": ">=5.6.0" - } - }, - "node_modules/sitemap/node_modules/@types/node": { - "version": "17.0.45", - "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.45.tgz", - "integrity": "sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==", - "license": "MIT" - }, - "node_modules/skin-tone": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/skin-tone/-/skin-tone-2.0.0.tgz", - "integrity": "sha512-kUMbT1oBJCpgrnKoSr0o6wPtvRWT9W9UKvGLwfJYO2WuahZRHOpEyL1ckyMGgMWh0UdpmaoFqKKD29WTomNEGA==", - "license": "MIT", - "dependencies": { - "unicode-emoji-modifier-base": "^1.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/slash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", - "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/snake-case": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", - "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", - "license": "MIT", - "dependencies": { - "dot-case": "^3.0.4", - "tslib": "^2.0.3" - } - }, - "node_modules/sockjs": { - "version": "0.3.24", - "resolved": "https://registry.npmjs.org/sockjs/-/sockjs-0.3.24.tgz", - "integrity": "sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ==", - "license": "MIT", - "dependencies": { - "faye-websocket": "^0.11.3", - "uuid": "^8.3.2", - "websocket-driver": "^0.7.4" - } - }, - "node_modules/sort-css-media-queries": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/sort-css-media-queries/-/sort-css-media-queries-2.2.0.tgz", - "integrity": "sha512-0xtkGhWCC9MGt/EzgnvbbbKhqWjl1+/rncmhTh5qCpbYguXh6S/qwePfv/JQ8jePXXmqingylxoC49pCkSPIbA==", - "license": "MIT", - "engines": { - "node": ">= 6.3.0" - } - }, - "node_modules/source-map": { - "version": "0.7.6", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", - "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", - "license": "BSD-3-Clause", - "engines": { - "node": ">= 12" - } - }, - "node_modules/source-map-js": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", - "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", - "license": "BSD-3-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/source-map-support": { - "version": "0.5.21", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", - "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", - "license": "MIT", - "dependencies": { - "buffer-from": "^1.0.0", - "source-map": "^0.6.0" - } - }, - "node_modules/source-map-support/node_modules/source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "license": "BSD-3-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/space-separated-tokens": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", - "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/spdy": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/spdy/-/spdy-4.0.2.tgz", - "integrity": "sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA==", - "license": "MIT", - "dependencies": { - "debug": "^4.1.0", - "handle-thing": "^2.0.0", - "http-deceiver": "^1.2.7", - "select-hose": "^2.0.0", - "spdy-transport": "^3.0.0" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/spdy-transport": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/spdy-transport/-/spdy-transport-3.0.0.tgz", - "integrity": "sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw==", - "license": "MIT", - "dependencies": { - "debug": "^4.1.0", - "detect-node": "^2.0.4", - "hpack.js": "^2.1.6", - "obuf": "^1.1.2", - "readable-stream": "^3.0.6", - "wbuf": "^1.7.3" - } - }, - "node_modules/sprintf-js": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", - "license": "BSD-3-Clause" - }, - "node_modules/srcset": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/srcset/-/srcset-4.0.0.tgz", - "integrity": "sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/statuses": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", - "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/std-env": { - "version": "3.10.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", - "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", - "license": "MIT" - }, - "node_modules/string_decoder": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", - "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.2.0" - } - }, - "node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "license": "MIT", - "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/string-width/node_modules/ansi-regex": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", - "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/string-width/node_modules/strip-ansi": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", - "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", - "license": "MIT", - "dependencies": { - "ansi-regex": "^6.2.2" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/stringify-entities": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", - "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", - "license": "MIT", - "dependencies": { - "character-entities-html4": "^2.0.0", - "character-entities-legacy": "^3.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/stringify-object": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", - "integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==", - "license": "BSD-2-Clause", - "dependencies": { - "get-own-enumerable-property-symbols": "^3.0.0", - "is-obj": "^1.0.1", - "is-regexp": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/strip-ansi": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "license": "MIT", - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-bom-string": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/strip-bom-string/-/strip-bom-string-1.0.0.tgz", - "integrity": "sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g==", - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/strip-final-newline": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", - "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/style-to-js": { - "version": "1.1.21", - "resolved": "https://registry.npmjs.org/style-to-js/-/style-to-js-1.1.21.tgz", - "integrity": "sha512-RjQetxJrrUJLQPHbLku6U/ocGtzyjbJMP9lCNK7Ag0CNh690nSH8woqWH9u16nMjYBAok+i7JO1NP2pOy8IsPQ==", - "license": "MIT", - "dependencies": { - "style-to-object": "1.0.14" - } - }, - "node_modules/style-to-object": { - "version": "1.0.14", - "resolved": "https://registry.npmjs.org/style-to-object/-/style-to-object-1.0.14.tgz", - "integrity": "sha512-LIN7rULI0jBscWQYaSswptyderlarFkjQ+t79nzty8tcIAceVomEVlLzH5VP4Cmsv6MtKhs7qaAiwlcp+Mgaxw==", - "license": "MIT", - "dependencies": { - "inline-style-parser": "0.2.7" - } - }, - "node_modules/stylehacks": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-6.1.1.tgz", - "integrity": "sha512-gSTTEQ670cJNoaeIp9KX6lZmm8LJ3jPB5yJmX8Zq/wQxOsAFXV3qjWzHas3YYk1qesuVIyYWWUpZ0vSE/dTSGg==", - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/supports-preserve-symlinks-flag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", - "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/svg-parser": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/svg-parser/-/svg-parser-2.0.4.tgz", - "integrity": "sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ==", - "license": "MIT" - }, - "node_modules/svgo": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/svgo/-/svgo-3.3.3.tgz", - "integrity": "sha512-+wn7I4p7YgJhHs38k2TNjy1vCfPIfLIJWR5MnCStsN8WuuTcBnRKcMHQLMM2ijxGZmDoZwNv8ipl5aTTen62ng==", - "license": "MIT", - "dependencies": { - "commander": "^7.2.0", - "css-select": "^5.1.0", - "css-tree": "^2.3.1", - "css-what": "^6.1.0", - "csso": "^5.0.5", - "picocolors": "^1.0.0", - "sax": "^1.5.0" - }, - "bin": { - "svgo": "bin/svgo" - }, - "engines": { - "node": ">=14.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/svgo" - } - }, - "node_modules/svgo/node_modules/commander": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", - "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", - "license": "MIT", - "engines": { - "node": ">= 10" - } - }, - "node_modules/tapable": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.3.2.tgz", - "integrity": "sha512-1MOpMXuhGzGL5TTCZFItxCc0AARf1EZFQkGqMm7ERKj8+Hgr5oLvJOVFcC+lRmR8hCe2S3jC4T5D7Vg/d7/fhA==", - "license": "MIT", - "engines": { - "node": ">=6" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/terser": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.46.1.tgz", - "integrity": "sha512-vzCjQO/rgUuK9sf8VJZvjqiqiHFaZLnOiimmUuOKODxWL8mm/xua7viT7aqX7dgPY60otQjUotzFMmCB4VdmqQ==", - "license": "BSD-2-Clause", - "dependencies": { - "@jridgewell/source-map": "^0.3.3", - "acorn": "^8.15.0", - "commander": "^2.20.0", - "source-map-support": "~0.5.20" - }, - "bin": { - "terser": "bin/terser" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/terser-webpack-plugin": { - "version": "5.4.0", - "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.4.0.tgz", - "integrity": "sha512-Bn5vxm48flOIfkdl5CaD2+1CiUVbonWQ3KQPyP7/EuIl9Gbzq/gQFOzaMFUEgVjB1396tcK0SG8XcNJ/2kDH8g==", - "license": "MIT", - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.25", - "jest-worker": "^27.4.5", - "schema-utils": "^4.3.0", - "terser": "^5.31.1" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.1.0" - }, - "peerDependenciesMeta": { - "@swc/core": { - "optional": true - }, - "esbuild": { - "optional": true - }, - "uglify-js": { - "optional": true - } - } - }, - "node_modules/terser-webpack-plugin/node_modules/jest-worker": { - "version": "27.5.1", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", - "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", - "license": "MIT", - "dependencies": { - "@types/node": "*", - "merge-stream": "^2.0.0", - "supports-color": "^8.0.0" - }, - "engines": { - "node": ">= 10.13.0" - } - }, - "node_modules/terser-webpack-plugin/node_modules/supports-color": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", - "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/supports-color?sponsor=1" - } - }, - "node_modules/terser/node_modules/commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "license": "MIT" - }, - "node_modules/thingies": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/thingies/-/thingies-2.6.0.tgz", - "integrity": "sha512-rMHRjmlFLM1R96UYPvpmnc3LYtdFrT33JIB7L9hetGue1qAPfn1N2LJeEjxUSidu1Iku+haLZXDuEXUHNGO/lg==", - "license": "MIT", - "engines": { - "node": ">=10.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "^2" - } - }, - "node_modules/thunky": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/thunky/-/thunky-1.1.0.tgz", - "integrity": "sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA==", - "license": "MIT" - }, - "node_modules/tiny-invariant": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.3.tgz", - "integrity": "sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==", - "license": "MIT" - }, - "node_modules/tiny-warning": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", - "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==", - "license": "MIT" - }, - "node_modules/tinypool": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", - "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", - "license": "MIT", - "engines": { - "node": "^18.0.0 || >=20.0.0" - } - }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "license": "MIT", - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, - "node_modules/toidentifier": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", - "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", - "license": "MIT", - "engines": { - "node": ">=0.6" - } - }, - "node_modules/totalist": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/totalist/-/totalist-3.0.1.tgz", - "integrity": "sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==", - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/tree-dump": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/tree-dump/-/tree-dump-1.1.0.tgz", - "integrity": "sha512-rMuvhU4MCDbcbnleZTFezWsaZXRFemSqAM+7jPnzUl1fo9w3YEKOxAeui0fz3OI4EU4hf23iyA7uQRVko+UaBA==", - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/trim-lines": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", - "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/trough": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/trough/-/trough-2.2.0.tgz", - "integrity": "sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/tslib": { - "version": "2.8.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", - "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "license": "0BSD" - }, - "node_modules/tsyringe": { - "version": "4.10.0", - "resolved": "https://registry.npmjs.org/tsyringe/-/tsyringe-4.10.0.tgz", - "integrity": "sha512-axr3IdNuVIxnaK5XGEUFTu3YmAQ6lllgrvqfEoR16g/HGnYY/6We4oWENtAnzK6/LpJ2ur9PAb80RBt7/U4ugw==", - "license": "MIT", - "dependencies": { - "tslib": "^1.9.3" - }, - "engines": { - "node": ">= 6.0.0" - } - }, - "node_modules/tsyringe/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "license": "0BSD" - }, - "node_modules/type-fest": { - "version": "2.19.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz", - "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==", - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/type-is": { - "version": "1.6.18", - "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", - "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", - "license": "MIT", - "dependencies": { - "media-typer": "0.3.0", - "mime-types": "~2.1.24" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/type-is/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/type-is/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/typedarray-to-buffer": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", - "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", - "license": "MIT", - "dependencies": { - "is-typedarray": "^1.0.0" - } - }, - "node_modules/typedoc": { - "version": "0.28.18", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.18.tgz", - "integrity": "sha512-NTWTUOFRQ9+SGKKTuWKUioUkjxNwtS3JDRPVKZAXGHZy2wCA8bdv2iJiyeePn0xkmK+TCCqZFT0X7+2+FLjngA==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@gerrit0/mini-shiki": "^3.23.0", - "lunr": "^2.3.9", - "markdown-it": "^14.1.1", - "minimatch": "^10.2.4", - "yaml": "^2.8.2" - }, - "bin": { - "typedoc": "bin/typedoc" - }, - "engines": { - "node": ">= 18", - "pnpm": ">= 10" - }, - "peerDependencies": { - "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x || 6.0.x" - } - }, - "node_modules/typedoc-docusaurus-theme": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/typedoc-docusaurus-theme/-/typedoc-docusaurus-theme-1.4.2.tgz", - "integrity": "sha512-i9YYDcScLD0WUiX8I+LXHX3ZVvRDlJsmRo9l/uWrFT37cHlMz4Ay0GOnWzHUBnnwAo1uzYOw9RjUXznbWozBEA==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "typedoc-plugin-markdown": ">=4.8.0" - } - }, - "node_modules/typedoc-plugin-markdown": { - "version": "4.11.0", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.11.0.tgz", - "integrity": "sha512-2iunh2ALyfyh204OF7h2u0kuQ84xB3jFZtFyUr01nThJkLvR8oGGSSDlyt2gyO4kXhvUxDcVbO0y43+qX+wFbw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 18" - }, - "peerDependencies": { - "typedoc": "0.28.x" - } - }, - "node_modules/typedoc/node_modules/balanced-match": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", - "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", - "dev": true, - "license": "MIT", - "engines": { - "node": "18 || 20 || >=22" - } - }, - "node_modules/typedoc/node_modules/brace-expansion": { - "version": "5.0.5", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz", - "integrity": "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^4.0.2" - }, - "engines": { - "node": "18 || 20 || >=22" - } - }, - "node_modules/typedoc/node_modules/minimatch": { - "version": "10.2.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.4.tgz", - "integrity": "sha512-oRjTw/97aTBN0RHbYCdtF1MQfvusSIBQM0IZEgzl6426+8jSC0nF1a/GmnVLpfB9yyr6g6FTqWqiZVbxrtaCIg==", - "dev": true, - "license": "BlueOak-1.0.0", - "dependencies": { - "brace-expansion": "^5.0.2" - }, - "engines": { - "node": "18 || 20 || >=22" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/typescript": { - "version": "5.6.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", - "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", - "devOptional": true, - "license": "Apache-2.0", - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=14.17" - } - }, - "node_modules/uc.micro": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", - "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", - "dev": true, - "license": "MIT" - }, - "node_modules/undici": { - "version": "7.24.6", - "resolved": "https://registry.npmjs.org/undici/-/undici-7.24.6.tgz", - "integrity": "sha512-Xi4agocCbRzt0yYMZGMA6ApD7gvtUFaxm4ZmeacWI4cZxaF6C+8I8QfofC20NAePiB/IcvZmzkJ7XPa471AEtA==", - "license": "MIT", - "engines": { - "node": ">=20.18.1" - } - }, - "node_modules/undici-types": { - "version": "7.18.2", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", - "integrity": "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w==", - "license": "MIT" - }, - "node_modules/unicode-canonical-property-names-ecmascript": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz", - "integrity": "sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/unicode-emoji-modifier-base": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unicode-emoji-modifier-base/-/unicode-emoji-modifier-base-1.0.0.tgz", - "integrity": "sha512-yLSH4py7oFH3oG/9K+XWrz1pSi3dfUrWEnInbxMfArOfc1+33BlGPQtLsOYwvdMy11AwUBetYuaRxSPqgkq+8g==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/unicode-match-property-ecmascript": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", - "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", - "license": "MIT", - "dependencies": { - "unicode-canonical-property-names-ecmascript": "^2.0.0", - "unicode-property-aliases-ecmascript": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/unicode-match-property-value-ecmascript": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz", - "integrity": "sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/unicode-property-aliases-ecmascript": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz", - "integrity": "sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ==", - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/unified": { - "version": "11.0.5", - "resolved": "https://registry.npmjs.org/unified/-/unified-11.0.5.tgz", - "integrity": "sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0", - "bail": "^2.0.0", - "devlop": "^1.0.0", - "extend": "^3.0.0", - "is-plain-obj": "^4.0.0", - "trough": "^2.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/unique-string": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", - "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", - "license": "MIT", - "dependencies": { - "crypto-random-string": "^4.0.0" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/unist-util-is": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.1.tgz", - "integrity": "sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/unist-util-position": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", - "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/unist-util-position-from-estree": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/unist-util-position-from-estree/-/unist-util-position-from-estree-2.0.0.tgz", - "integrity": "sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/unist-util-stringify-position": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", - "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/unist-util-visit": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.1.0.tgz", - "integrity": "sha512-m+vIdyeCOpdr/QeQCu2EzxX/ohgS8KbnPDgFni4dQsfSCtpz8UqDyY5GjRru8PDKuYn7Fq19j1CQ+nJSsGKOzg==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0", - "unist-util-is": "^6.0.0", - "unist-util-visit-parents": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/unist-util-visit-parents": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.2.tgz", - "integrity": "sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0", - "unist-util-is": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/universalify": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", - "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", - "license": "MIT", - "engines": { - "node": ">= 10.0.0" - } - }, - "node_modules/unpipe": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", - "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/update-browserslist-db": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", - "integrity": "sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w==", - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/browserslist" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "MIT", - "dependencies": { - "escalade": "^3.2.0", - "picocolors": "^1.1.1" - }, - "bin": { - "update-browserslist-db": "cli.js" - }, - "peerDependencies": { - "browserslist": ">= 4.21.0" - } - }, - "node_modules/update-notifier": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", - "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", - "license": "BSD-2-Clause", - "dependencies": { - "boxen": "^7.0.0", - "chalk": "^5.0.1", - "configstore": "^6.0.0", - "has-yarn": "^3.0.0", - "import-lazy": "^4.0.0", - "is-ci": "^3.0.1", - "is-installed-globally": "^0.4.0", - "is-npm": "^6.0.0", - "is-yarn-global": "^0.4.0", - "latest-version": "^7.0.0", - "pupa": "^3.1.0", - "semver": "^7.3.7", - "semver-diff": "^4.0.0", - "xdg-basedir": "^5.1.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/yeoman/update-notifier?sponsor=1" - } - }, - "node_modules/update-notifier/node_modules/boxen": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.1.1.tgz", - "integrity": "sha512-2hCgjEmP8YLWQ130n2FerGv7rYpfBmnmp9Uy2Le1vge6X3gZIfSmEzP5QTDElFxcvVcXlEn8Aq6MU/PZygIOog==", - "license": "MIT", - "dependencies": { - "ansi-align": "^3.0.1", - "camelcase": "^7.0.1", - "chalk": "^5.2.0", - "cli-boxes": "^3.0.0", - "string-width": "^5.1.2", - "type-fest": "^2.13.0", - "widest-line": "^4.0.1", - "wrap-ansi": "^8.1.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/update-notifier/node_modules/camelcase": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.1.tgz", - "integrity": "sha512-xlx1yCK2Oc1APsPXDL2LdlNP6+uu8OCDdhOBSVT279M/S+y75O30C2VuD8T2ogdePBBl7PfPF4504tnLgX3zfw==", - "license": "MIT", - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/update-notifier/node_modules/chalk": { - "version": "5.6.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", - "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", - "license": "MIT", - "engines": { - "node": "^12.17.0 || ^14.13 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/uri-js": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", - "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "license": "BSD-2-Clause", - "dependencies": { - "punycode": "^2.1.0" - } - }, - "node_modules/url-loader": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/url-loader/-/url-loader-4.1.1.tgz", - "integrity": "sha512-3BTV812+AVHHOJQO8O5MkWgZ5aosP7GnROJwvzLS9hWDj00lZ6Z0wNak423Lp9PBZN05N+Jk/N5Si8jRAlGyWA==", - "license": "MIT", - "dependencies": { - "loader-utils": "^2.0.0", - "mime-types": "^2.1.27", - "schema-utils": "^3.0.0" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "file-loader": "*", - "webpack": "^4.0.0 || ^5.0.0" - }, - "peerDependenciesMeta": { - "file-loader": { - "optional": true - } - } - }, - "node_modules/url-loader/node_modules/ajv": { - "version": "6.14.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", - "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/url-loader/node_modules/ajv-keywords": { - "version": "3.5.2", - "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", - "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", - "license": "MIT", - "peerDependencies": { - "ajv": "^6.9.1" - } - }, - "node_modules/url-loader/node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "license": "MIT" - }, - "node_modules/url-loader/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/url-loader/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/url-loader/node_modules/schema-utils": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", - "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", - "license": "MIT", - "dependencies": { - "@types/json-schema": "^7.0.8", - "ajv": "^6.12.5", - "ajv-keywords": "^3.5.2" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/util-deprecate": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", - "license": "MIT" - }, - "node_modules/utila": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/utila/-/utila-0.4.0.tgz", - "integrity": "sha512-Z0DbgELS9/L/75wZbro8xAnT50pBVFQZ+hUEueGDU5FN51YSCYM+jdxsfCiHjwNP/4LCDD0i/graKpeBnOXKRA==", - "license": "MIT" - }, - "node_modules/utility-types": { - "version": "3.11.0", - "resolved": "https://registry.npmjs.org/utility-types/-/utility-types-3.11.0.tgz", - "integrity": "sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw==", - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/utils-merge": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", - "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", - "license": "MIT", - "engines": { - "node": ">= 0.4.0" - } - }, - "node_modules/uuid": { - "version": "8.3.2", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", - "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", - "license": "MIT", - "bin": { - "uuid": "dist/bin/uuid" - } - }, - "node_modules/value-equal": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/value-equal/-/value-equal-1.0.1.tgz", - "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==", - "license": "MIT" - }, - "node_modules/vary": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", - "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/vfile": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", - "integrity": "sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0", - "vfile-message": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/vfile-location": { - "version": "5.0.3", - "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-5.0.3.tgz", - "integrity": "sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0", - "vfile": "^6.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/vfile-message": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.3.tgz", - "integrity": "sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw==", - "license": "MIT", - "dependencies": { - "@types/unist": "^3.0.0", - "unist-util-stringify-position": "^4.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/watchpack": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.5.1.tgz", - "integrity": "sha512-Zn5uXdcFNIA1+1Ei5McRd+iRzfhENPCe7LeABkJtNulSxjma+l7ltNx55BWZkRlwRnpOgHqxnjyaDgJnNXnqzg==", - "license": "MIT", - "dependencies": { - "glob-to-regexp": "^0.4.1", - "graceful-fs": "^4.1.2" - }, - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/wbuf": { - "version": "1.7.3", - "resolved": "https://registry.npmjs.org/wbuf/-/wbuf-1.7.3.tgz", - "integrity": "sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA==", - "license": "MIT", - "dependencies": { - "minimalistic-assert": "^1.0.0" - } - }, - "node_modules/web-namespaces": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/web-namespaces/-/web-namespaces-2.0.1.tgz", - "integrity": "sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/webpack": { - "version": "5.105.4", - "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.105.4.tgz", - "integrity": "sha512-jTywjboN9aHxFlToqb0K0Zs9SbBoW4zRUlGzI2tYNxVYcEi/IPpn+Xi4ye5jTLvX2YeLuic/IvxNot+Q1jMoOw==", - "license": "MIT", - "dependencies": { - "@types/eslint-scope": "^3.7.7", - "@types/estree": "^1.0.8", - "@types/json-schema": "^7.0.15", - "@webassemblyjs/ast": "^1.14.1", - "@webassemblyjs/wasm-edit": "^1.14.1", - "@webassemblyjs/wasm-parser": "^1.14.1", - "acorn": "^8.16.0", - "acorn-import-phases": "^1.0.3", - "browserslist": "^4.28.1", - "chrome-trace-event": "^1.0.2", - "enhanced-resolve": "^5.20.0", - "es-module-lexer": "^2.0.0", - "eslint-scope": "5.1.1", - "events": "^3.2.0", - "glob-to-regexp": "^0.4.1", - "graceful-fs": "^4.2.11", - "json-parse-even-better-errors": "^2.3.1", - "loader-runner": "^4.3.1", - "mime-types": "^2.1.27", - "neo-async": "^2.6.2", - "schema-utils": "^4.3.3", - "tapable": "^2.3.0", - "terser-webpack-plugin": "^5.3.17", - "watchpack": "^2.5.1", - "webpack-sources": "^3.3.4" - }, - "bin": { - "webpack": "bin/webpack.js" - }, - "engines": { - "node": ">=10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependenciesMeta": { - "webpack-cli": { - "optional": true - } - } - }, - "node_modules/webpack-bundle-analyzer": { - "version": "4.10.2", - "resolved": "https://registry.npmjs.org/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.2.tgz", - "integrity": "sha512-vJptkMm9pk5si4Bv922ZbKLV8UTT4zib4FPgXMhgzUny0bfDDkLXAVQs3ly3fS4/TN9ROFtb0NFrm04UXFE/Vw==", - "license": "MIT", - "dependencies": { - "@discoveryjs/json-ext": "0.5.7", - "acorn": "^8.0.4", - "acorn-walk": "^8.0.0", - "commander": "^7.2.0", - "debounce": "^1.2.1", - "escape-string-regexp": "^4.0.0", - "gzip-size": "^6.0.0", - "html-escaper": "^2.0.2", - "opener": "^1.5.2", - "picocolors": "^1.0.0", - "sirv": "^2.0.3", - "ws": "^7.3.1" - }, - "bin": { - "webpack-bundle-analyzer": "lib/bin/analyzer.js" - }, - "engines": { - "node": ">= 10.13.0" - } - }, - "node_modules/webpack-bundle-analyzer/node_modules/commander": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", - "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", - "license": "MIT", - "engines": { - "node": ">= 10" - } - }, - "node_modules/webpack-dev-middleware": { - "version": "7.4.5", - "resolved": "https://registry.npmjs.org/webpack-dev-middleware/-/webpack-dev-middleware-7.4.5.tgz", - "integrity": "sha512-uxQ6YqGdE4hgDKNf7hUiPXOdtkXvBJXrfEGYSx7P7LC8hnUYGK70X6xQXUvXeNyBDDcsiQXpG2m3G9vxowaEuA==", - "license": "MIT", - "dependencies": { - "colorette": "^2.0.10", - "memfs": "^4.43.1", - "mime-types": "^3.0.1", - "on-finished": "^2.4.1", - "range-parser": "^1.2.1", - "schema-utils": "^4.0.0" - }, - "engines": { - "node": ">= 18.12.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.0.0" - }, - "peerDependenciesMeta": { - "webpack": { - "optional": true - } - } - }, - "node_modules/webpack-dev-middleware/node_modules/mime-db": { - "version": "1.54.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", - "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/webpack-dev-middleware/node_modules/mime-types": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.2.tgz", - "integrity": "sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A==", - "license": "MIT", - "dependencies": { - "mime-db": "^1.54.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/express" - } - }, - "node_modules/webpack-dev-middleware/node_modules/range-parser": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", - "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/webpack-dev-server": { - "version": "5.2.3", - "resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-5.2.3.tgz", - "integrity": "sha512-9Gyu2F7+bg4Vv+pjbovuYDhHX+mqdqITykfzdM9UyKqKHlsE5aAjRhR+oOEfXW5vBeu8tarzlJFIZva4ZjAdrQ==", - "license": "MIT", - "dependencies": { - "@types/bonjour": "^3.5.13", - "@types/connect-history-api-fallback": "^1.5.4", - "@types/express": "^4.17.25", - "@types/express-serve-static-core": "^4.17.21", - "@types/serve-index": "^1.9.4", - "@types/serve-static": "^1.15.5", - "@types/sockjs": "^0.3.36", - "@types/ws": "^8.5.10", - "ansi-html-community": "^0.0.8", - "bonjour-service": "^1.2.1", - "chokidar": "^3.6.0", - "colorette": "^2.0.10", - "compression": "^1.8.1", - "connect-history-api-fallback": "^2.0.0", - "express": "^4.22.1", - "graceful-fs": "^4.2.6", - "http-proxy-middleware": "^2.0.9", - "ipaddr.js": "^2.1.0", - "launch-editor": "^2.6.1", - "open": "^10.0.3", - "p-retry": "^6.2.0", - "schema-utils": "^4.2.0", - "selfsigned": "^5.5.0", - "serve-index": "^1.9.1", - "sockjs": "^0.3.24", - "spdy": "^4.0.2", - "webpack-dev-middleware": "^7.4.2", - "ws": "^8.18.0" - }, - "bin": { - "webpack-dev-server": "bin/webpack-dev-server.js" - }, - "engines": { - "node": ">= 18.12.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.0.0" - }, - "peerDependenciesMeta": { - "webpack": { - "optional": true - }, - "webpack-cli": { - "optional": true - } - } - }, - "node_modules/webpack-dev-server/node_modules/define-lazy-prop": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz", - "integrity": "sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/webpack-dev-server/node_modules/open": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/open/-/open-10.2.0.tgz", - "integrity": "sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA==", - "license": "MIT", - "dependencies": { - "default-browser": "^5.2.1", - "define-lazy-prop": "^3.0.0", - "is-inside-container": "^1.0.0", - "wsl-utils": "^0.1.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/webpack-dev-server/node_modules/ws": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.20.0.tgz", - "integrity": "sha512-sAt8BhgNbzCtgGbt2OxmpuryO63ZoDk/sqaB/znQm94T4fCEsy/yV+7CdC1kJhOU9lboAEU7R3kquuycDoibVA==", - "license": "MIT", - "engines": { - "node": ">=10.0.0" - }, - "peerDependencies": { - "bufferutil": "^4.0.1", - "utf-8-validate": ">=5.0.2" - }, - "peerDependenciesMeta": { - "bufferutil": { - "optional": true - }, - "utf-8-validate": { - "optional": true - } - } - }, - "node_modules/webpack-merge": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-6.0.1.tgz", - "integrity": "sha512-hXXvrjtx2PLYx4qruKl+kyRSLc52V+cCvMxRjmKwoA+CBbbF5GfIBtR6kCvl0fYGqTUPKB+1ktVmTHqMOzgCBg==", - "license": "MIT", - "dependencies": { - "clone-deep": "^4.0.1", - "flat": "^5.0.2", - "wildcard": "^2.0.1" - }, - "engines": { - "node": ">=18.0.0" - } - }, - "node_modules/webpack-sources": { - "version": "3.3.4", - "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.3.4.tgz", - "integrity": "sha512-7tP1PdV4vF+lYPnkMR0jMY5/la2ub5Fc/8VQrrU+lXkiM6C4TjVfGw7iKfyhnTQOsD+6Q/iKw0eFciziRgD58Q==", - "license": "MIT", - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/webpack/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/webpack/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/webpackbar": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/webpackbar/-/webpackbar-6.0.1.tgz", - "integrity": "sha512-TnErZpmuKdwWBdMoexjio3KKX6ZtoKHRVvLIU0A47R0VVBDtx3ZyOJDktgYixhoJokZTYTt1Z37OkO9pnGJa9Q==", - "license": "MIT", - "dependencies": { - "ansi-escapes": "^4.3.2", - "chalk": "^4.1.2", - "consola": "^3.2.3", - "figures": "^3.2.0", - "markdown-table": "^2.0.0", - "pretty-time": "^1.1.0", - "std-env": "^3.7.0", - "wrap-ansi": "^7.0.0" - }, - "engines": { - "node": ">=14.21.3" - }, - "peerDependencies": { - "webpack": "3 || 4 || 5" - } - }, - "node_modules/webpackbar/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "license": "MIT" - }, - "node_modules/webpackbar/node_modules/markdown-table": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-2.0.0.tgz", - "integrity": "sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A==", - "license": "MIT", - "dependencies": { - "repeat-string": "^1.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/webpackbar/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "license": "MIT", - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/webpackbar/node_modules/wrap-ansi": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/websocket-driver": { - "version": "0.7.4", - "resolved": "https://registry.npmjs.org/websocket-driver/-/websocket-driver-0.7.4.tgz", - "integrity": "sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg==", - "license": "Apache-2.0", - "dependencies": { - "http-parser-js": ">=0.5.1", - "safe-buffer": ">=5.1.0", - "websocket-extensions": ">=0.1.1" - }, - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/websocket-extensions": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/websocket-extensions/-/websocket-extensions-0.1.4.tgz", - "integrity": "sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg==", - "license": "Apache-2.0", - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/whatwg-encoding": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", - "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==", - "deprecated": "Use @exodus/bytes instead for a more spec-conformant and faster implementation", - "license": "MIT", - "dependencies": { - "iconv-lite": "0.6.3" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/whatwg-encoding/node_modules/iconv-lite": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", - "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/whatwg-mimetype": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", - "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", - "license": "MIT", - "engines": { - "node": ">=18" - } - }, - "node_modules/which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "license": "ISC", - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/node-which" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/widest-line": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", - "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", - "license": "MIT", - "dependencies": { - "string-width": "^5.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/wildcard": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/wildcard/-/wildcard-2.0.1.tgz", - "integrity": "sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==", - "license": "MIT" - }, - "node_modules/wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "license": "MIT", - "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/wrap-ansi/node_modules/ansi-regex": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", - "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/wrap-ansi/node_modules/ansi-styles": { - "version": "6.2.3", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", - "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/wrap-ansi/node_modules/strip-ansi": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", - "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", - "license": "MIT", - "dependencies": { - "ansi-regex": "^6.2.2" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/write-file-atomic": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", - "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", - "license": "ISC", - "dependencies": { - "imurmurhash": "^0.1.4", - "is-typedarray": "^1.0.0", - "signal-exit": "^3.0.2", - "typedarray-to-buffer": "^3.1.5" - } - }, - "node_modules/ws": { - "version": "7.5.10", - "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz", - "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==", - "license": "MIT", - "engines": { - "node": ">=8.3.0" - }, - "peerDependencies": { - "bufferutil": "^4.0.1", - "utf-8-validate": "^5.0.2" - }, - "peerDependenciesMeta": { - "bufferutil": { - "optional": true - }, - "utf-8-validate": { - "optional": true + "name": "website", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "website", + "version": "0.0.0", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", + "@easyops-cn/docusaurus-search-local": "^0.55.1", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "prism-react-renderer": "^2.3.0", + "react": "^19.0.0", + "react-dom": "^19.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", + "@docusaurus/types": "3.9.2", + "docusaurus-plugin-typedoc": "^1.4.2", + "raw-loader": "^4.0.2", + "typedoc": "^0.28.18", + "typedoc-plugin-markdown": "^4.11.0", + "typescript": "~5.6.2" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@algolia/abtesting": { + "version": "1.16.0", + "resolved": "https://registry.npmjs.org/@algolia/abtesting/-/abtesting-1.16.0.tgz", + "integrity": "sha512-alHFZ68/i9qLC/muEB07VQ9r7cB8AvCcGX6dVQi2PNHhc/ZQRmmFAv8KK1ay4UiseGSFr7f0nXBKsZ/jRg7e4g==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/autocomplete-core": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-core/-/autocomplete-core-1.19.2.tgz", + "integrity": "sha512-mKv7RyuAzXvwmq+0XRK8HqZXt9iZ5Kkm2huLjgn5JoCPtDy+oh9yxUMfDDaVCw0oyzZ1isdJBc7l9nuCyyR7Nw==", + "license": "MIT", + "dependencies": { + "@algolia/autocomplete-plugin-algolia-insights": "1.19.2", + "@algolia/autocomplete-shared": "1.19.2" + } + }, + "node_modules/@algolia/autocomplete-plugin-algolia-insights": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.2.tgz", + "integrity": "sha512-TjxbcC/r4vwmnZaPwrHtkXNeqvlpdyR+oR9Wi2XyfORkiGkLTVhX2j+O9SaCCINbKoDfc+c2PB8NjfOnz7+oKg==", + "license": "MIT", + "dependencies": { + "@algolia/autocomplete-shared": "1.19.2" + }, + "peerDependencies": { + "search-insights": ">= 1 < 3" + } + }, + "node_modules/@algolia/autocomplete-shared": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.2.tgz", + "integrity": "sha512-jEazxZTVD2nLrC+wYlVHQgpBoBB5KPStrJxLzsIFl6Kqd1AlG9sIAGl39V5tECLpIQzB3Qa2T6ZPJ1ChkwMK/w==", + "license": "MIT", + "peerDependencies": { + "@algolia/client-search": ">= 4.9.1 < 6", + "algoliasearch": ">= 4.9.1 < 6" + } + }, + "node_modules/@algolia/client-abtesting": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-abtesting/-/client-abtesting-5.50.0.tgz", + "integrity": "sha512-mfgUdLQNxOAvCZUGzPQxjahEWEPuQkKlV0ZtGmePOa9ZxIQZlk31vRBNbM6ScU8jTH41SCYE77G/lCifDr1SVw==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-analytics": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-5.50.0.tgz", + "integrity": "sha512-5mjokeKYyPaP3Q8IYJEnutI+O4dW/Ixxx5IgsSxT04pCfGqPXxTOH311hTQxyNpcGGEOGrMv8n8Z+UMTPamioQ==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-common": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-common/-/client-common-5.50.0.tgz", + "integrity": "sha512-emtOvR6dl3rX3sBJXXbofMNHU1qMQqQSWu319RMrNL5BWoBqyiq7y0Zn6cjJm7aGHV/Qbf+KCCYeWNKEMPI3BQ==", + "license": "MIT", + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-insights": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-insights/-/client-insights-5.50.0.tgz", + "integrity": "sha512-IerGH2/hcj/6bwkpQg/HHRqmlGN1XwygQWythAk0gZFBrghs9danJaYuSS3ShzLSVoIVth4jY5GDPX9Lbw5cgg==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-personalization": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-5.50.0.tgz", + "integrity": "sha512-3idPJeXn5L0MmgP9jk9JJqblrQ/SguN93dNK9z9gfgyupBhHnJMOEjrRYcVgTIfvG13Y04wO+Q0FxE2Ut8PVbA==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-query-suggestions": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-query-suggestions/-/client-query-suggestions-5.50.0.tgz", + "integrity": "sha512-q7qRoWrQK1a8m5EFQEmPlo7+pg9mVQ8X5jsChtChERre0uS2pdYEDixBBl0ydBSGkdGbLUDufcACIhH/077E4g==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/client-search": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.50.0.tgz", + "integrity": "sha512-Jc360x4yqb3eEg4OY4KEIdGePBxZogivKI+OGIU8aLXgAYPTECvzeOBc90312yHA1hr3AeRlAFl0rIc8lQaIrQ==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/events": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@algolia/events/-/events-4.0.1.tgz", + "integrity": "sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ==", + "license": "MIT" + }, + "node_modules/@algolia/ingestion": { + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/@algolia/ingestion/-/ingestion-1.50.0.tgz", + "integrity": "sha512-OS3/Viao+NPpyBbEY3tf6hLewppG+UclD+9i0ju56mq2DrdMJFCkEky6Sk9S5VPcbLzxzg3BqBX6u9Q35w19aQ==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/monitoring": { + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/@algolia/monitoring/-/monitoring-1.50.0.tgz", + "integrity": "sha512-/znwgSiGufpbJVIoDmeQaHtTq+OMdDawFRbMSJVv+12n79hW+qdQXS8/Uu3BD3yn0BzgVFJEvrsHrCsInZKdhw==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/recommend": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/recommend/-/recommend-5.50.0.tgz", + "integrity": "sha512-dHjUfu4jfjdQiKDpCpAnM7LP5yfG0oNShtfpF5rMCel6/4HIoqJ4DC4h5GKDzgrvJYtgAhblo0AYBmOM00T+lQ==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/requester-browser-xhr": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.50.0.tgz", + "integrity": "sha512-bffIbUljAWnh/Ctu5uScORajuUavqmZ0ACYd1fQQeSSYA9NNN83ynO26pSc2dZRXpSK0fkc1//qSSFXMKGu+aw==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/requester-fetch": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-fetch/-/requester-fetch-5.50.0.tgz", + "integrity": "sha512-y0EwNvPGvkM+yTAqqO6Gpt9wVGm3CLDtpLvNEiB3VGvN3WzfkjZGtLUsG/ru2kVJIIU7QcV0puuYgEpBeFxcJg==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/requester-node-http": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-5.50.0.tgz", + "integrity": "sha512-xpwefe4fCOWnZgXCbkGpqQY6jgBSCf2hmgnySbyzZIccrv3SoashHKGPE4x6vVG+gdHrGciMTAcDo9HOZwH22Q==", + "license": "MIT", + "dependencies": { + "@algolia/client-common": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.28.5", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/compat-data": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.0.tgz", + "integrity": "sha512-T1NCJqT/j9+cn8fvkt7jtwbLBfLC/1y1c7NtCeXFRgzGTsafi68MRv8yzkYSapBnFA6L3U2VSc02ciDzoAJhJg==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", + "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helpers": "^7.28.6", + "@babel/parser": "^7.29.0", + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.29.0", + "@babel/types": "^7.29.0", + "@jridgewell/remapping": "^2.3.5", + "convert-source-map": "^2.0.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/core/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/generator": { + "version": "7.29.1", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.1.tgz", + "integrity": "sha512-qsaF+9Qcm2Qv8SRIMMscAvG4O3lJ0F1GuMo5HR/Bp02LopNgnZBC/EkbevHFeGs4ls/oPz9v+Bsmzbkbe+0dUw==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.29.0", + "@babel/types": "^7.29.0", + "@jridgewell/gen-mapping": "^0.3.12", + "@jridgewell/trace-mapping": "^0.3.28", + "jsesc": "^3.0.2" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-annotate-as-pure": { + "version": "7.27.3", + "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz", + "integrity": "sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.27.3" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz", + "integrity": "sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA==", + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.28.6", + "@babel/helper-validator-option": "^7.27.1", + "browserslist": "^4.24.0", + "lru-cache": "^5.1.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-create-class-features-plugin": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.6.tgz", + "integrity": "sha512-dTOdvsjnG3xNT9Y0AUg1wAl38y+4Rl4sf9caSQZOXdNqVn+H+HbbJ4IyyHaIqNR6SW9oJpA/RuRjsjCw2IdIow==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-member-expression-to-functions": "^7.28.5", + "@babel/helper-optimise-call-expression": "^7.27.1", + "@babel/helper-replace-supers": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", + "@babel/traverse": "^7.28.6", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-class-features-plugin/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.28.5.tgz", + "integrity": "sha512-N1EhvLtHzOvj7QQOUCCS3NrPJP8c5W6ZXCHDn7Yialuy1iu4r5EmIYkXlKNqT99Ciw+W0mDqWoR6HWMZlFP3hw==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "regexpu-core": "^6.3.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-define-polyfill-provider": { + "version": "0.6.8", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.8.tgz", + "integrity": "sha512-47UwBLPpQi1NoWzLuHNjRoHlYXMwIJoBf7MFou6viC/sIHWYygpvr0B6IAyh5sBdA2nr2LPIRww8lfaUVQINBA==", + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "debug": "^4.4.3", + "lodash.debounce": "^4.0.8", + "resolve": "^1.22.11" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/helper-globals": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", + "integrity": "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-member-expression-to-functions": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.28.5.tgz", + "integrity": "sha512-cwM7SBRZcPCLgl8a7cY0soT1SptSzAlMH39vwiRpOQkJlh53r5hdHwLSCZpQdVLT39sZt+CRpNwYG4Y2v77atg==", + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.28.5", + "@babel/types": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz", + "integrity": "sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw==", + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz", + "integrity": "sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-optimise-call-expression": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz", + "integrity": "sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.28.6.tgz", + "integrity": "sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-remap-async-to-generator": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz", + "integrity": "sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.1", + "@babel/helper-wrap-function": "^7.27.1", + "@babel/traverse": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-replace-supers": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.28.6.tgz", + "integrity": "sha512-mq8e+laIk94/yFec3DxSjCRD2Z0TAjhVbEJY3UQrlwVo15Lmt7C2wAUbK4bjnTs4APkwsYLTahXRraQXhb1WCg==", + "license": "MIT", + "dependencies": { + "@babel/helper-member-expression-to-functions": "^7.28.5", + "@babel/helper-optimise-call-expression": "^7.27.1", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-skip-transparent-expression-wrappers": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz", + "integrity": "sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg==", + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.27.1", + "@babel/types": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", + "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", + "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-wrap-function": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.28.6.tgz", + "integrity": "sha512-z+PwLziMNBeSQJonizz2AGnndLsP2DeGHIxDAn+wdHOGuo4Fo1x1HBPPXeE9TAOPHNNWQKCSlA2VZyYyyibDnQ==", + "license": "MIT", + "dependencies": { + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.29.2.tgz", + "integrity": "sha512-HoGuUs4sCZNezVEKdVcwqmZN8GoHirLUcLaYVNBK2J0DadGtdcqgr3BCbvH8+XUo4NGjNl3VOtSjEKNzqfFgKw==", + "license": "MIT", + "dependencies": { + "@babel/template": "^7.28.6", + "@babel/types": "^7.29.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.2.tgz", + "integrity": "sha512-4GgRzy/+fsBa72/RZVJmGKPmZu9Byn8o4MoLpmNe1m8ZfYnz5emHLQz3U4gLud6Zwl0RZIcgiLD7Uq7ySFuDLA==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.29.0" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.28.5.tgz", + "integrity": "sha512-87GDMS3tsmMSi/3bWOte1UblL+YUTFMV8SZPZ2eSEL17s74Cw/l63rR6NmGVKMYW2GYi85nE+/d6Hw5N0bEk2Q==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/traverse": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-safari-class-field-initializer-scope": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz", + "integrity": "sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz", + "integrity": "sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz", + "integrity": "sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", + "@babel/plugin-transform-optional-chaining": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.13.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.6.tgz", + "integrity": "sha512-a0aBScVTlNaiUe35UtfxAN7A/tehvvG4/ByO6+46VPKTRSlfnAFsgKy0FUh+qAkQrDTmhDkT+IBOKlOoMUxQ0g==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-proposal-private-property-in-object": { + "version": "7.21.0-placeholder-for-preset-env.2", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", + "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-dynamic-import": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz", + "integrity": "sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-assertions": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.28.6.tgz", + "integrity": "sha512-pSJUpFHdx9z5nqTSirOCMtYVP2wFgoWhP0p3g8ONK/4IHhLIBd0B9NYqAvIUAhq+OkhO4VM1tENCt0cjlsNShw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-attributes": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.28.6.tgz", + "integrity": "sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-jsx": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.28.6.tgz", + "integrity": "sha512-wgEmr06G6sIpqr8YDwA2dSRTE3bJ+V0IfpzfSY3Lfgd7YWOaAdlykvJi13ZKBt8cZHfgH1IXN+CL656W3uUa4w==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-typescript": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.28.6.tgz", + "integrity": "sha512-+nDNmQye7nlnuuHDboPbGm00Vqg3oO8niRRL27/4LYHUsHYh0zJ1xWOz0uRwNFmM1Avzk8wZbc6rdiYhomzv/A==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-unicode-sets-regex": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", + "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.18.6", + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-arrow-functions": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz", + "integrity": "sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-generator-functions": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.29.0.tgz", + "integrity": "sha512-va0VdWro4zlBr2JsXC+ofCPB2iG12wPtVGTWFx2WLDOM3nYQZZIGP82qku2eW/JR83sD+k2k+CsNtyEbUqhU6w==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-remap-async-to-generator": "^7.27.1", + "@babel/traverse": "^7.29.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-to-generator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.28.6.tgz", + "integrity": "sha512-ilTRcmbuXjsMmcZ3HASTe4caH5Tpo93PkTxF9oG2VZsSWsahydmcEHhix9Ik122RcTnZnUzPbmux4wh1swfv7g==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-remap-async-to-generator": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoped-functions": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz", + "integrity": "sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoping": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.6.tgz", + "integrity": "sha512-tt/7wOtBmwHPNMPu7ax4pdPz6shjFrmHDghvNC+FG9Qvj7D6mJcoRQIF5dy4njmxR941l6rgtvfSB2zX3VlUIw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-properties": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.28.6.tgz", + "integrity": "sha512-dY2wS3I2G7D697VHndN91TJr8/AAfXQNt5ynCTI/MpxMsSzHp+52uNivYT5wCPax3whc47DR8Ba7cmlQMg24bw==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-static-block": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.6.tgz", + "integrity": "sha512-rfQ++ghVwTWTqQ7w8qyDxL1XGihjBss4CmTgGRCTAC9RIbhVpyp4fOeZtta0Lbf+dTNIVJer6ych2ibHwkZqsQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0" + } + }, + "node_modules/@babel/plugin-transform-classes": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.6.tgz", + "integrity": "sha512-EF5KONAqC5zAqT783iMGuM2ZtmEBy+mJMOKl2BCvPZ2lVrwvXnB6o+OBWCS+CoeCCpVRF2sA2RBKUxvT8tQT5Q==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-globals": "^7.28.0", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-replace-supers": "^7.28.6", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-computed-properties": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.28.6.tgz", + "integrity": "sha512-bcc3k0ijhHbc2lEfpFHgx7eYw9KNXqOerKWfzbxEHUGKnS3sz9C4CNL9OiFN1297bDNfUiSO7DaLzbvHQQQ1BQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/template": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-destructuring": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.5.tgz", + "integrity": "sha512-Kl9Bc6D0zTUcFUvkNuQh4eGXPKKNDOJQXVyyM4ZAQPMveniJdxi8XMJwLo+xSoW3MIq81bD33lcUe9kZpl0MCw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/traverse": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-dotall-regex": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.28.6.tgz", + "integrity": "sha512-SljjowuNKB7q5Oayv4FoPzeB74g3QgLt8IVJw9ADvWy3QnUb/01aw8I4AVv8wYnPvQz2GDDZ/g3GhcNyDBI4Bg==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-duplicate-keys": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz", + "integrity": "sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-duplicate-named-capturing-groups-regex": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.29.0.tgz", + "integrity": "sha512-zBPcW2lFGxdiD8PUnPwJjag2J9otbcLQzvbiOzDxpYXyCuYX9agOwMPGn1prVH0a4qzhCKu24rlH4c1f7yA8rw==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-dynamic-import": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz", + "integrity": "sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-explicit-resource-management": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.6.tgz", + "integrity": "sha512-Iao5Konzx2b6g7EPqTy40UZbcdXE126tTxVFr/nAIj+WItNxjKSYTEw3RC+A2/ZetmdJsgueL1KhaMCQHkLPIg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-exponentiation-operator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.28.6.tgz", + "integrity": "sha512-WitabqiGjV/vJ0aPOLSFfNY1u9U3R7W36B03r5I2KoNix+a3sOhJ3pKFB3R5It9/UiK78NiO0KE9P21cMhlPkw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-export-namespace-from": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz", + "integrity": "sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-for-of": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz", + "integrity": "sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-function-name": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz", + "integrity": "sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/traverse": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-json-strings": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.28.6.tgz", + "integrity": "sha512-Nr+hEN+0geQkzhbdgQVPoqr47lZbm+5fCUmO70722xJZd0Mvb59+33QLImGj6F+DkK3xgDi1YVysP8whD6FQAw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-literals": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz", + "integrity": "sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-logical-assignment-operators": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.28.6.tgz", + "integrity": "sha512-+anKKair6gpi8VsM/95kmomGNMD0eLz1NQ8+Pfw5sAwWH9fGYXT50E55ZpV0pHUHWf6IUTWPM+f/7AAff+wr9A==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-member-expression-literals": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz", + "integrity": "sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-amd": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz", + "integrity": "sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-commonjs": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.28.6.tgz", + "integrity": "sha512-jppVbf8IV9iWWwWTQIxJMAJCWBuuKx71475wHwYytrRGQ2CWiDvYlADQno3tcYpS/T2UUWFQp3nVtYfK/YBQrA==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-systemjs": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.29.0.tgz", + "integrity": "sha512-PrujnVFbOdUpw4UHiVwKvKRLMMic8+eC0CuNlxjsyZUiBjhFdPsewdXCkveh2KqBA9/waD0W1b4hXSOBQJezpQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.29.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-umd": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz", + "integrity": "sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.29.0.tgz", + "integrity": "sha512-1CZQA5KNAD6ZYQLPw7oi5ewtDNxH/2vuCh+6SmvgDfhumForvs8a1o9n0UrEoBD8HU4djO2yWngTQlXl1NDVEQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-new-target": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz", + "integrity": "sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.28.6.tgz", + "integrity": "sha512-3wKbRgmzYbw24mDJXT7N+ADXw8BC/imU9yo9c9X9NKaLF1fW+e5H1U5QjMUBe4Qo4Ox/o++IyUkl1sVCLgevKg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-numeric-separator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.28.6.tgz", + "integrity": "sha512-SJR8hPynj8outz+SlStQSwvziMN4+Bq99it4tMIf5/Caq+3iOc0JtKyse8puvyXkk3eFRIA5ID/XfunGgO5i6w==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-rest-spread": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.6.tgz", + "integrity": "sha512-5rh+JR4JBC4pGkXLAcYdLHZjXudVxWMXbB6u6+E9lRL5TrGVbHt1TjxGbZ8CkmYw9zjkB7jutzOROArsqtncEA==", + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5", + "@babel/plugin-transform-parameters": "^7.27.7", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-super": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz", + "integrity": "sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-replace-supers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-catch-binding": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.28.6.tgz", + "integrity": "sha512-R8ja/Pyrv0OGAvAXQhSTmWyPJPml+0TMqXlO5w+AsMEiwb2fg3WkOvob7UxFSL3OIttFSGSRFKQsOhJ/X6HQdQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-chaining": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.28.6.tgz", + "integrity": "sha512-A4zobikRGJTsX9uqVFdafzGkqD30t26ck2LmOzAuLL8b2x6k3TIqRiT2xVvA9fNmFeTX484VpsdgmKNA0bS23w==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-parameters": { + "version": "7.27.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz", + "integrity": "sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-methods": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.28.6.tgz", + "integrity": "sha512-piiuapX9CRv7+0st8lmuUlRSmX6mBcVeNQ1b4AYzJxfCMuBfB0vBXDiGSmm03pKJw1v6cZ8KSeM+oUnM6yAExg==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-property-in-object": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.28.6.tgz", + "integrity": "sha512-b97jvNSOb5+ehyQmBpmhOCiUC5oVK4PMnpRvO7+ymFBoqYjeDHIU9jnrNUuwHOiL9RpGDoKBpSViarV+BU+eVA==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-property-literals": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz", + "integrity": "sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-constant-elements": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.27.1.tgz", + "integrity": "sha512-edoidOjl/ZxvYo4lSBOQGDSyToYVkTAwyVoa2tkuYTSmjrB1+uAedoL5iROVLXkxH+vRgA7uP4tMg2pUJpZ3Ug==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-display-name": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.28.0.tgz", + "integrity": "sha512-D6Eujc2zMxKjfa4Zxl4GHMsmhKKZ9VpcqIchJLvwTxad9zWIYulwYItBovpDOoNLISpcZSXoDJ5gaGbQUDqViA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.28.6.tgz", + "integrity": "sha512-61bxqhiRfAACulXSLd/GxqmAedUSrRZIu/cbaT18T1CetkTmtDN15it7i80ru4DVqRK1WMxQhXs+Lf9kajm5Ow==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-syntax-jsx": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx-development": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-development/-/plugin-transform-react-jsx-development-7.27.1.tgz", + "integrity": "sha512-ykDdF5yI4f1WrAolLqeF3hmYU12j9ntLQl/AOG1HAS21jxyg1Q0/J/tpREuYLfatGdGmXp/3yS0ZA76kOlVq9Q==", + "license": "MIT", + "dependencies": { + "@babel/plugin-transform-react-jsx": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-pure-annotations": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.27.1.tgz", + "integrity": "sha512-JfuinvDOsD9FVMTHpzA/pBLisxpv1aSf+OIV8lgH3MuWrks19R27e6a6DipIg4aX1Zm9Wpb04p8wljfKrVSnPA==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-regenerator": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.29.0.tgz", + "integrity": "sha512-FijqlqMA7DmRdg/aINBSs04y8XNTYw/lr1gJ2WsmBnnaNw1iS43EPkJW+zK7z65auG3AWRFXWj+NcTQwYptUog==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-regexp-modifiers": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.28.6.tgz", + "integrity": "sha512-QGWAepm9qxpaIs7UM9FvUSnCGlb8Ua1RhyM4/veAxLwt3gMat/LSGrZixyuj4I6+Kn9iwvqCyPTtbdxanYoWYg==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-reserved-words": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz", + "integrity": "sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.29.0.tgz", + "integrity": "sha512-jlaRT5dJtMaMCV6fAuLbsQMSwz/QkvaHOHOSXRitGGwSpR1blCY4KUKoyP2tYO8vJcqYe8cEj96cqSztv3uF9w==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "babel-plugin-polyfill-corejs2": "^0.4.14", + "babel-plugin-polyfill-corejs3": "^0.13.0", + "babel-plugin-polyfill-regenerator": "^0.6.5", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/plugin-transform-shorthand-properties": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz", + "integrity": "sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-spread": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.28.6.tgz", + "integrity": "sha512-9U4QObUC0FtJl05AsUcodau/RWDytrU6uKgkxu09mLR9HLDAtUMoPuuskm5huQsoktmsYpI+bGmq+iapDcriKA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-sticky-regex": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz", + "integrity": "sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-template-literals": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz", + "integrity": "sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typeof-symbol": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz", + "integrity": "sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typescript": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.28.6.tgz", + "integrity": "sha512-0YWL2RFxOqEm9Efk5PvreamxPME8OyY0wM5wh5lHjF+VtVhdneCWGzZeSqzOfiobVqQaNCd2z0tQvnI9DaPWPw==", + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", + "@babel/plugin-syntax-typescript": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-escapes": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz", + "integrity": "sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-property-regex": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.28.6.tgz", + "integrity": "sha512-4Wlbdl/sIZjzi/8St0evF0gEZrgOswVO6aOzqxh1kDZOl9WmLrHq2HtGhnOJZmHZYKP8WZ1MDLCt5DAWwRo57A==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-regex": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz", + "integrity": "sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.27.1", + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-sets-regex": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.28.6.tgz", + "integrity": "sha512-/wHc/paTUmsDYN7SZkpWxogTOBNnlx7nBQYfy6JJlCT7G3mVhltk3e++N7zV0XfgGsrqBxd4rJQt9H16I21Y1Q==", + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/preset-env": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.29.2.tgz", + "integrity": "sha512-DYD23veRYGvBFhcTY1iUvJnDNpuqNd/BzBwCvzOTKUnJjKg5kpUBh3/u9585Agdkgj+QuygG7jLfOPWMa2KVNw==", + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.29.0", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-validator-option": "^7.27.1", + "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", + "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.6", + "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", + "@babel/plugin-syntax-import-assertions": "^7.28.6", + "@babel/plugin-syntax-import-attributes": "^7.28.6", + "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", + "@babel/plugin-transform-arrow-functions": "^7.27.1", + "@babel/plugin-transform-async-generator-functions": "^7.29.0", + "@babel/plugin-transform-async-to-generator": "^7.28.6", + "@babel/plugin-transform-block-scoped-functions": "^7.27.1", + "@babel/plugin-transform-block-scoping": "^7.28.6", + "@babel/plugin-transform-class-properties": "^7.28.6", + "@babel/plugin-transform-class-static-block": "^7.28.6", + "@babel/plugin-transform-classes": "^7.28.6", + "@babel/plugin-transform-computed-properties": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5", + "@babel/plugin-transform-dotall-regex": "^7.28.6", + "@babel/plugin-transform-duplicate-keys": "^7.27.1", + "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.29.0", + "@babel/plugin-transform-dynamic-import": "^7.27.1", + "@babel/plugin-transform-explicit-resource-management": "^7.28.6", + "@babel/plugin-transform-exponentiation-operator": "^7.28.6", + "@babel/plugin-transform-export-namespace-from": "^7.27.1", + "@babel/plugin-transform-for-of": "^7.27.1", + "@babel/plugin-transform-function-name": "^7.27.1", + "@babel/plugin-transform-json-strings": "^7.28.6", + "@babel/plugin-transform-literals": "^7.27.1", + "@babel/plugin-transform-logical-assignment-operators": "^7.28.6", + "@babel/plugin-transform-member-expression-literals": "^7.27.1", + "@babel/plugin-transform-modules-amd": "^7.27.1", + "@babel/plugin-transform-modules-commonjs": "^7.28.6", + "@babel/plugin-transform-modules-systemjs": "^7.29.0", + "@babel/plugin-transform-modules-umd": "^7.27.1", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.29.0", + "@babel/plugin-transform-new-target": "^7.27.1", + "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6", + "@babel/plugin-transform-numeric-separator": "^7.28.6", + "@babel/plugin-transform-object-rest-spread": "^7.28.6", + "@babel/plugin-transform-object-super": "^7.27.1", + "@babel/plugin-transform-optional-catch-binding": "^7.28.6", + "@babel/plugin-transform-optional-chaining": "^7.28.6", + "@babel/plugin-transform-parameters": "^7.27.7", + "@babel/plugin-transform-private-methods": "^7.28.6", + "@babel/plugin-transform-private-property-in-object": "^7.28.6", + "@babel/plugin-transform-property-literals": "^7.27.1", + "@babel/plugin-transform-regenerator": "^7.29.0", + "@babel/plugin-transform-regexp-modifiers": "^7.28.6", + "@babel/plugin-transform-reserved-words": "^7.27.1", + "@babel/plugin-transform-shorthand-properties": "^7.27.1", + "@babel/plugin-transform-spread": "^7.28.6", + "@babel/plugin-transform-sticky-regex": "^7.27.1", + "@babel/plugin-transform-template-literals": "^7.27.1", + "@babel/plugin-transform-typeof-symbol": "^7.27.1", + "@babel/plugin-transform-unicode-escapes": "^7.27.1", + "@babel/plugin-transform-unicode-property-regex": "^7.28.6", + "@babel/plugin-transform-unicode-regex": "^7.27.1", + "@babel/plugin-transform-unicode-sets-regex": "^7.28.6", + "@babel/preset-modules": "0.1.6-no-external-plugins", + "babel-plugin-polyfill-corejs2": "^0.4.15", + "babel-plugin-polyfill-corejs3": "^0.14.0", + "babel-plugin-polyfill-regenerator": "^0.6.6", + "core-js-compat": "^3.48.0", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-env/node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.14.2.tgz", + "integrity": "sha512-coWpDLJ410R781Npmn/SIBZEsAetR4xVi0SxLMXPaMO4lSf1MwnkGYMtkFxew0Dn8B3/CpbpYxN0JCgg8mn67g==", + "license": "MIT", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.8", + "core-js-compat": "^3.48.0" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/preset-env/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/preset-modules": { + "version": "0.1.6-no-external-plugins", + "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", + "integrity": "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@babel/types": "^7.4.4", + "esutils": "^2.0.2" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/preset-react": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.28.5.tgz", + "integrity": "sha512-Z3J8vhRq7CeLjdC58jLv4lnZ5RKFUJWqH5emvxmv9Hv3BD1T9R/Im713R4MTKwvFaV74ejZ3sM01LyEKk4ugNQ==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-validator-option": "^7.27.1", + "@babel/plugin-transform-react-display-name": "^7.28.0", + "@babel/plugin-transform-react-jsx": "^7.27.1", + "@babel/plugin-transform-react-jsx-development": "^7.27.1", + "@babel/plugin-transform-react-pure-annotations": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-typescript": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.28.5.tgz", + "integrity": "sha512-+bQy5WOI2V6LJZpPVxY+yp66XdZ2yifu0Mc1aP5CQKgjn4QM5IN2i5fAZ4xKop47pr8rpVhiAeu+nDQa12C8+g==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-validator-option": "^7.27.1", + "@babel/plugin-syntax-jsx": "^7.27.1", + "@babel/plugin-transform-modules-commonjs": "^7.27.1", + "@babel/plugin-transform-typescript": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.29.2.tgz", + "integrity": "sha512-JiDShH45zKHWyGe4ZNVRrCjBz8Nh9TMmZG1kh4QTK8hCBTWBi8Da+i7s1fJw7/lYpM4ccepSNfqzZ/QvABBi5g==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/runtime-corejs3": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.29.2.tgz", + "integrity": "sha512-Lc94FOD5+0aXhdb0Tdg3RUtqT6yWbI/BbFWvlaSJ3gAb9Ks+99nHRDKADVqC37er4eCB0fHyWT+y+K3QOvJKbw==", + "license": "MIT", + "dependencies": { + "core-js-pure": "^3.48.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/template": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.28.6.tgz", + "integrity": "sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.28.6", + "@babel/parser": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.0.tgz", + "integrity": "sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", + "@babel/helper-globals": "^7.28.0", + "@babel/parser": "^7.29.0", + "@babel/template": "^7.28.6", + "@babel/types": "^7.29.0", + "debug": "^4.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", + "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.27.1", + "@babel/helper-validator-identifier": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@colors/colors": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", + "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", + "license": "MIT", + "optional": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@csstools/cascade-layer-name-parser": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz", + "integrity": "sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/color-helpers": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/css-calc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/css-color-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/css-parser-algorithms": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/css-tokenizer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@csstools/media-query-list-parser": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz", + "integrity": "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + } + }, + "node_modules/@csstools/postcss-alpha-function": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-alpha-function/-/postcss-alpha-function-1.0.1.tgz", + "integrity": "sha512-isfLLwksH3yHkFXfCI2Gcaqg7wGGHZZwunoJzEZk0yKYIokgre6hYVFibKL3SYAoR1kBXova8LB+JoO5vZzi9w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-cascade-layers": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz", + "integrity": "sha512-nWBE08nhO8uWl6kSAeCx4im7QfVko3zLrtgWZY4/bP87zrSPpSyN/3W3TDqz1jJuH+kbKOHXg5rJnK+ZVYcFFg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/selector-specificity": "^5.0.0", + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-cascade-layers/node_modules/@csstools/selector-specificity": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", + "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/@csstools/postcss-cascade-layers/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@csstools/postcss-color-function": { + "version": "4.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-color-function/-/postcss-color-function-4.0.12.tgz", + "integrity": "sha512-yx3cljQKRaSBc2hfh8rMZFZzChaFgwmO2JfFgFr1vMcF3C/uyy5I4RFIBOIWGq1D+XbKCG789CGkG6zzkLpagA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-color-function-display-p3-linear": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-color-function-display-p3-linear/-/postcss-color-function-display-p3-linear-1.0.1.tgz", + "integrity": "sha512-E5qusdzhlmO1TztYzDIi8XPdPoYOjoTY6HBYBCYSj+Gn4gQRBlvjgPQXzfzuPQqt8EhkC/SzPKObg4Mbn8/xMg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-color-mix-function": { + "version": "3.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.12.tgz", + "integrity": "sha512-4STERZfCP5Jcs13P1U5pTvI9SkgLgfMUMhdXW8IlJWkzOOOqhZIjcNhWtNJZes2nkBDsIKJ0CJtFtuaZ00moag==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-color-mix-variadic-function-arguments": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.2.tgz", + "integrity": "sha512-rM67Gp9lRAkTo+X31DUqMEq+iK+EFqsidfecmhrteErxJZb6tUoJBVQca1Vn1GpDql1s1rD1pKcuYzMsg7Z1KQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-content-alt-text": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.8.tgz", + "integrity": "sha512-9SfEW9QCxEpTlNMnpSqFaHyzsiRpZ5J5+KqCu1u5/eEJAWsMhzT40qf0FIbeeglEvrGRMdDzAxMIz3wqoGSb+Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-contrast-color-function": { + "version": "2.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-contrast-color-function/-/postcss-contrast-color-function-2.0.12.tgz", + "integrity": "sha512-YbwWckjK3qwKjeYz/CijgcS7WDUCtKTd8ShLztm3/i5dhh4NaqzsbYnhm4bjrpFpnLZ31jVcbK8YL77z3GBPzA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-exponential-functions": { + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz", + "integrity": "sha512-abg2W/PI3HXwS/CZshSa79kNWNZHdJPMBXeZNyPQFbbj8sKO3jXxOt/wF7juJVjyDTc6JrvaUZYFcSBZBhaxjw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-font-format-keywords": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-font-format-keywords/-/postcss-font-format-keywords-4.0.0.tgz", + "integrity": "sha512-usBzw9aCRDvchpok6C+4TXC57btc4bJtmKQWOHQxOVKen1ZfVqBUuCZ/wuqdX5GHsD0NRSr9XTP+5ID1ZZQBXw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-gamut-mapping": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.11.tgz", + "integrity": "sha512-fCpCUgZNE2piVJKC76zFsgVW1apF6dpYsqGyH8SIeCcM4pTEsRTWTLCaJIMKFEundsCKwY1rwfhtrio04RJ4Dw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-gradients-interpolation-method": { + "version": "5.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.12.tgz", + "integrity": "sha512-jugzjwkUY0wtNrZlFeyXzimUL3hN4xMvoPnIXxoZqxDvjZRiSh+itgHcVUWzJ2VwD/VAMEgCLvtaJHX+4Vj3Ow==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-hwb-function": { + "version": "4.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.12.tgz", + "integrity": "sha512-mL/+88Z53KrE4JdePYFJAQWFrcADEqsLprExCM04GDNgHIztwFzj0Mbhd/yxMBngq0NIlz58VVxjt5abNs1VhA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-ic-unit": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.4.tgz", + "integrity": "sha512-yQ4VmossuOAql65sCPppVO1yfb7hDscf4GseF0VCA/DTDaBc0Wtf8MTqVPfjGYlT5+2buokG0Gp7y0atYZpwjg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-initial": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-initial/-/postcss-initial-2.0.1.tgz", + "integrity": "sha512-L1wLVMSAZ4wovznquK0xmC7QSctzO4D0Is590bxpGqhqjboLXYA16dWZpfwImkdOgACdQ9PqXsuRroW6qPlEsg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-is-pseudo-class": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.3.tgz", + "integrity": "sha512-jS/TY4SpG4gszAtIg7Qnf3AS2pjcUM5SzxpApOrlndMeGhIbaTzWBzzP/IApXoNWEW7OhcjkRT48jnAUIFXhAQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/selector-specificity": "^5.0.0", + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-is-pseudo-class/node_modules/@csstools/selector-specificity": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", + "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/@csstools/postcss-is-pseudo-class/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@csstools/postcss-light-dark-function": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.11.tgz", + "integrity": "sha512-fNJcKXJdPM3Lyrbmgw2OBbaioU7yuKZtiXClf4sGdQttitijYlZMD5K7HrC/eF83VRWRrYq6OZ0Lx92leV2LFA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-float-and-clear": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-float-and-clear/-/postcss-logical-float-and-clear-3.0.0.tgz", + "integrity": "sha512-SEmaHMszwakI2rqKRJgE+8rpotFfne1ZS6bZqBoQIicFyV+xT1UF42eORPxJkVJVrH9C0ctUgwMSn3BLOIZldQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-overflow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-overflow/-/postcss-logical-overflow-2.0.0.tgz", + "integrity": "sha512-spzR1MInxPuXKEX2csMamshR4LRaSZ3UXVaRGjeQxl70ySxOhMpP2252RAFsg8QyyBXBzuVOOdx1+bVO5bPIzA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-overscroll-behavior": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-overscroll-behavior/-/postcss-logical-overscroll-behavior-2.0.0.tgz", + "integrity": "sha512-e/webMjoGOSYfqLunyzByZj5KKe5oyVg/YSbie99VEaSDE2kimFm0q1f6t/6Jo+VVCQ/jbe2Xy+uX+C4xzWs4w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-resize": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-resize/-/postcss-logical-resize-3.0.0.tgz", + "integrity": "sha512-DFbHQOFW/+I+MY4Ycd/QN6Dg4Hcbb50elIJCfnwkRTCX05G11SwViI5BbBlg9iHRl4ytB7pmY5ieAFk3ws7yyg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-logical-viewport-units": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.4.tgz", + "integrity": "sha512-q+eHV1haXA4w9xBwZLKjVKAWn3W2CMqmpNpZUk5kRprvSiBEGMgrNH3/sJZ8UA3JgyHaOt3jwT9uFa4wLX4EqQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-media-minmax": { + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz", + "integrity": "sha512-af9Qw3uS3JhYLnCbqtZ9crTvvkR+0Se+bBqSr7ykAnl9yKhk6895z9rf+2F4dClIDJWxgn0iZZ1PSdkhrbs2ig==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/media-query-list-parser": "^4.0.3" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz", + "integrity": "sha512-zhAe31xaaXOY2Px8IYfoVTB3wglbJUVigGphFLj6exb7cjZRH9A6adyE22XfFK3P2PzwRk0VDeTJmaxpluyrDg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/media-query-list-parser": "^4.0.3" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-nested-calc": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-nested-calc/-/postcss-nested-calc-4.0.0.tgz", + "integrity": "sha512-jMYDdqrQQxE7k9+KjstC3NbsmC063n1FTPLCgCRS2/qHUbHM0mNy9pIn4QIiQGs9I/Bg98vMqw7mJXBxa0N88A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-normalize-display-values": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-normalize-display-values/-/postcss-normalize-display-values-4.0.1.tgz", + "integrity": "sha512-TQUGBuRvxdc7TgNSTevYqrL8oItxiwPDixk20qCB5me/W8uF7BPbhRrAvFuhEoywQp/woRsUZ6SJ+sU5idZAIA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-oklab-function": { + "version": "4.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.12.tgz", + "integrity": "sha512-HhlSmnE1NKBhXsTnNGjxvhryKtO7tJd1w42DKOGFD6jSHtYOrsJTQDKPMwvOfrzUAk8t7GcpIfRyM7ssqHpFjg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-position-area-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-position-area-property/-/postcss-position-area-property-1.0.0.tgz", + "integrity": "sha512-fUP6KR8qV2NuUZV3Cw8itx0Ep90aRjAZxAEzC3vrl6yjFv+pFsQbR18UuQctEKmA72K9O27CoYiKEgXxkqjg8Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-progressive-custom-properties": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.2.1.tgz", + "integrity": "sha512-uPiiXf7IEKtUQXsxu6uWtOlRMXd2QWWy5fhxHDnPdXKCQckPP3E34ZgDoZ62r2iT+UOgWsSbM4NvHE5m3mAEdw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-property-rule-prelude-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-property-rule-prelude-list/-/postcss-property-rule-prelude-list-1.0.0.tgz", + "integrity": "sha512-IxuQjUXq19fobgmSSvUDO7fVwijDJaZMvWQugxfEUxmjBeDCVaDuMpsZ31MsTm5xbnhA+ElDi0+rQ7sQQGisFA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-random-function": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz", + "integrity": "sha512-q+FQaNiRBhnoSNo+GzqGOIBKoHQ43lYz0ICrV+UudfWnEF6ksS6DsBIJSISKQT2Bvu3g4k6r7t0zYrk5pDlo8w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-relative-color-syntax": { + "version": "3.0.12", + "resolved": "https://registry.npmjs.org/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.12.tgz", + "integrity": "sha512-0RLIeONxu/mtxRtf3o41Lq2ghLimw0w9ByLWnnEVuy89exmEEq8bynveBxNW3nyHqLAFEeNtVEmC1QK9MZ8Huw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-scope-pseudo-class": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-scope-pseudo-class/-/postcss-scope-pseudo-class-4.0.1.tgz", + "integrity": "sha512-IMi9FwtH6LMNuLea1bjVMQAsUhFxJnyLSgOp/cpv5hrzWmrUYU5fm0EguNDIIOHUqzXode8F/1qkC/tEo/qN8Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-scope-pseudo-class/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@csstools/postcss-sign-functions": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.4.tgz", + "integrity": "sha512-P97h1XqRPcfcJndFdG95Gv/6ZzxUBBISem0IDqPZ7WMvc/wlO+yU0c5D/OCpZ5TJoTt63Ok3knGk64N+o6L2Pg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-stepped-value-functions": { + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz", + "integrity": "sha512-h9btycWrsex4dNLeQfyU3y3w40LMQooJWFMm/SK9lrKguHDcFl4VMkncKKoXi2z5rM9YGWbUQABI8BT2UydIcA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-syntax-descriptor-syntax-production": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@csstools/postcss-syntax-descriptor-syntax-production/-/postcss-syntax-descriptor-syntax-production-1.0.1.tgz", + "integrity": "sha512-GneqQWefjM//f4hJ/Kbox0C6f2T7+pi4/fqTqOFGTL3EjnvOReTqO1qUQ30CaUjkwjYq9qZ41hzarrAxCc4gow==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-system-ui-font-family": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-system-ui-font-family/-/postcss-system-ui-font-family-1.0.0.tgz", + "integrity": "sha512-s3xdBvfWYfoPSBsikDXbuorcMG1nN1M6GdU0qBsGfcmNR0A/qhloQZpTxjA3Xsyrk1VJvwb2pOfiOT3at/DuIQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-text-decoration-shorthand": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz", + "integrity": "sha512-KSkGgZfx0kQjRIYnpsD7X2Om9BUXX/Kii77VBifQW9Ih929hK0KNjVngHDH0bFB9GmfWcR9vJYJJRvw/NQjkrA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/color-helpers": "^5.1.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-trigonometric-functions": { + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz", + "integrity": "sha512-Hnh5zJUdpNrJqK9v1/E3BbrQhaDTj5YiX7P61TOvUhoDHnUmsNNxcDAgkQ32RrcWx9GVUvfUNPcUkn8R3vIX6A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-calc": "^2.1.4", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/postcss-unset-value": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz", + "integrity": "sha512-cBz3tOCI5Fw6NIFEwU3RiwK6mn3nKegjpJuzCndoGq3BZPkUjnsq7uQmIeMNeMbMk7YD2MfKcgCpZwX5jyXqCA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@csstools/utilities": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@csstools/utilities/-/utilities-2.0.0.tgz", + "integrity": "sha512-5VdOr0Z71u+Yp3ozOx8T11N703wIFGVRgOWbOZMKgglPJsWA54MRIoMNVMa7shUToIhx5J8vX4sOZgD2XiihiQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/@discoveryjs/json-ext": { + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz", + "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", + "license": "MIT", + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/@docsearch/core": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/core/-/core-4.6.2.tgz", + "integrity": "sha512-/S0e6Dj7Zcm8m9Rru49YEX49dhU11be68c+S/BCyN8zQsTTgkKzXlhRbVL5mV6lOLC2+ZRRryaTdcm070Ug2oA==", + "license": "MIT", + "peerDependencies": { + "@types/react": ">= 16.8.0 < 20.0.0", + "react": ">= 16.8.0 < 20.0.0", + "react-dom": ">= 16.8.0 < 20.0.0" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + }, + "react": { + "optional": true + }, + "react-dom": { + "optional": true + } + } + }, + "node_modules/@docsearch/css": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/css/-/css-4.6.2.tgz", + "integrity": "sha512-fH/cn8BjEEdM2nJdjNMHIvOVYupG6AIDtFVDgIZrNzdCSj4KXr9kd+hsehqsNGYjpUjObeKYKvgy/IwCb1jZYQ==", + "license": "MIT" + }, + "node_modules/@docsearch/react": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/react/-/react-4.6.2.tgz", + "integrity": "sha512-/BbtGFtqVOGwZx0dw/UfhN/0/DmMQYnulY4iv0tPRhC2JCXv0ka/+izwt3Jzo1ZxXS/2eMvv9zHsBJOK1I9f/w==", + "license": "MIT", + "dependencies": { + "@algolia/autocomplete-core": "1.19.2", + "@docsearch/core": "4.6.2", + "@docsearch/css": "4.6.2" + }, + "peerDependencies": { + "@types/react": ">= 16.8.0 < 20.0.0", + "react": ">= 16.8.0 < 20.0.0", + "react-dom": ">= 16.8.0 < 20.0.0", + "search-insights": ">= 1 < 3" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + }, + "react": { + "optional": true + }, + "react-dom": { + "optional": true + }, + "search-insights": { + "optional": true + } + } + }, + "node_modules/@docusaurus/babel": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/babel/-/babel-3.9.2.tgz", + "integrity": "sha512-GEANdi/SgER+L7Japs25YiGil/AUDnFFHaCGPBbundxoWtCkA2lmy7/tFmgED4y1htAy6Oi4wkJEQdGssnw9MA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.25.9", + "@babel/generator": "^7.25.9", + "@babel/plugin-syntax-dynamic-import": "^7.8.3", + "@babel/plugin-transform-runtime": "^7.25.9", + "@babel/preset-env": "^7.25.9", + "@babel/preset-react": "^7.25.9", + "@babel/preset-typescript": "^7.25.9", + "@babel/runtime": "^7.25.9", + "@babel/runtime-corejs3": "^7.25.9", + "@babel/traverse": "^7.25.9", + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "babel-plugin-dynamic-import-node": "^2.3.3", + "fs-extra": "^11.1.1", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/bundler": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/bundler/-/bundler-3.9.2.tgz", + "integrity": "sha512-ZOVi6GYgTcsZcUzjblpzk3wH1Fya2VNpd5jtHoCCFcJlMQ1EYXZetfAnRHLcyiFeBABaI1ltTYbOBtH/gahGVA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.25.9", + "@docusaurus/babel": "3.9.2", + "@docusaurus/cssnano-preset": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "babel-loader": "^9.2.1", + "clean-css": "^5.3.3", + "copy-webpack-plugin": "^11.0.0", + "css-loader": "^6.11.0", + "css-minimizer-webpack-plugin": "^5.0.1", + "cssnano": "^6.1.2", + "file-loader": "^6.2.0", + "html-minifier-terser": "^7.2.0", + "mini-css-extract-plugin": "^2.9.2", + "null-loader": "^4.0.1", + "postcss": "^8.5.4", + "postcss-loader": "^7.3.4", + "postcss-preset-env": "^10.2.1", + "terser-webpack-plugin": "^5.3.9", + "tslib": "^2.6.0", + "url-loader": "^4.1.1", + "webpack": "^5.95.0", + "webpackbar": "^6.0.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "@docusaurus/faster": "*" + }, + "peerDependenciesMeta": { + "@docusaurus/faster": { + "optional": true + } + } + }, + "node_modules/@docusaurus/core": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/core/-/core-3.9.2.tgz", + "integrity": "sha512-HbjwKeC+pHUFBfLMNzuSjqFE/58+rLVKmOU3lxQrpsxLBOGosYco/Q0GduBb0/jEMRiyEqjNT/01rRdOMWq5pw==", + "license": "MIT", + "dependencies": { + "@docusaurus/babel": "3.9.2", + "@docusaurus/bundler": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "boxen": "^6.2.1", + "chalk": "^4.1.2", + "chokidar": "^3.5.3", + "cli-table3": "^0.6.3", + "combine-promises": "^1.1.0", + "commander": "^5.1.0", + "core-js": "^3.31.1", + "detect-port": "^1.5.1", + "escape-html": "^1.0.3", + "eta": "^2.2.0", + "eval": "^0.1.8", + "execa": "5.1.1", + "fs-extra": "^11.1.1", + "html-tags": "^3.3.1", + "html-webpack-plugin": "^5.6.0", + "leven": "^3.1.0", + "lodash": "^4.17.21", + "open": "^8.4.0", + "p-map": "^4.0.0", + "prompts": "^2.4.2", + "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", + "react-loadable": "npm:@docusaurus/react-loadable@6.0.0", + "react-loadable-ssr-addon-v5-slorber": "^1.0.1", + "react-router": "^5.3.4", + "react-router-config": "^5.1.1", + "react-router-dom": "^5.3.4", + "semver": "^7.5.4", + "serve-handler": "^6.1.6", + "tinypool": "^1.0.2", + "tslib": "^2.6.0", + "update-notifier": "^6.0.2", + "webpack": "^5.95.0", + "webpack-bundle-analyzer": "^4.10.2", + "webpack-dev-server": "^5.2.2", + "webpack-merge": "^6.0.1" + }, + "bin": { + "docusaurus": "bin/docusaurus.mjs" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "@mdx-js/react": "^3.0.0", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/cssnano-preset": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/cssnano-preset/-/cssnano-preset-3.9.2.tgz", + "integrity": "sha512-8gBKup94aGttRduABsj7bpPFTX7kbwu+xh3K9NMCF5K4bWBqTFYW+REKHF6iBVDHRJ4grZdIPbvkiHd/XNKRMQ==", + "license": "MIT", + "dependencies": { + "cssnano-preset-advanced": "^6.1.2", + "postcss": "^8.5.4", + "postcss-sort-media-queries": "^5.2.0", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/logger": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/logger/-/logger-3.9.2.tgz", + "integrity": "sha512-/SVCc57ByARzGSU60c50rMyQlBuMIJCjcsJlkphxY6B0GV4UH3tcA1994N8fFfbJ9kX3jIBe/xg3XP5qBtGDbA==", + "license": "MIT", + "dependencies": { + "chalk": "^4.1.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/mdx-loader": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/mdx-loader/-/mdx-loader-3.9.2.tgz", + "integrity": "sha512-wiYoGwF9gdd6rev62xDU8AAM8JuLI/hlwOtCzMmYcspEkzecKrP8J8X+KpYnTlACBUUtXNJpSoCwFWJhLRevzQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@mdx-js/mdx": "^3.0.0", + "@slorber/remark-comment": "^1.0.0", + "escape-html": "^1.0.3", + "estree-util-value-to-estree": "^3.0.1", + "file-loader": "^6.2.0", + "fs-extra": "^11.1.1", + "image-size": "^2.0.2", + "mdast-util-mdx": "^3.0.0", + "mdast-util-to-string": "^4.0.0", + "rehype-raw": "^7.0.0", + "remark-directive": "^3.0.0", + "remark-emoji": "^4.0.0", + "remark-frontmatter": "^5.0.0", + "remark-gfm": "^4.0.0", + "stringify-object": "^3.3.0", + "tslib": "^2.6.0", + "unified": "^11.0.3", + "unist-util-visit": "^5.0.0", + "url-loader": "^4.1.1", + "vfile": "^6.0.1", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/module-type-aliases": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/module-type-aliases/-/module-type-aliases-3.9.2.tgz", + "integrity": "sha512-8qVe2QA9hVLzvnxP46ysuofJUIc/yYQ82tvA/rBTrnpXtCjNSFLxEZfd5U8cYZuJIVlkPxamsIgwd5tGZXfvew==", + "license": "MIT", + "dependencies": { + "@docusaurus/types": "3.9.2", + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router-config": "*", + "@types/react-router-dom": "*", + "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", + "react-loadable": "npm:@docusaurus/react-loadable@6.0.0" + }, + "peerDependencies": { + "react": "*", + "react-dom": "*" + } + }, + "node_modules/@docusaurus/plugin-content-blog": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.9.2.tgz", + "integrity": "sha512-3I2HXy3L1QcjLJLGAoTvoBnpOwa6DPUa3Q0dMK19UTY9mhPkKQg/DYhAGTiBUKcTR0f08iw7kLPqOhIgdV3eVQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "cheerio": "1.0.0-rc.12", + "feed": "^4.2.2", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "schema-dts": "^1.1.2", + "srcset": "^4.0.0", + "tslib": "^2.6.0", + "unist-util-visit": "^5.0.0", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "@docusaurus/plugin-content-docs": "*", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-content-docs": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz", + "integrity": "sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@types/react-router-config": "^5.0.7", + "combine-promises": "^1.1.0", + "fs-extra": "^11.1.1", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "schema-dts": "^1.1.2", + "tslib": "^2.6.0", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-content-pages": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.9.2.tgz", + "integrity": "sha512-s4849w/p4noXUrGpPUF0BPqIAfdAe76BLaRGAGKZ1gTDNiGxGcpsLcwJ9OTi1/V8A+AzvsmI9pkjie2zjIQZKA==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "fs-extra": "^11.1.1", + "tslib": "^2.6.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-css-cascade-layers": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.9.2.tgz", + "integrity": "sha512-w1s3+Ss+eOQbscGM4cfIFBlVg/QKxyYgj26k5AnakuHkKxH6004ZtuLe5awMBotIYF2bbGDoDhpgQ4r/kcj4rQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/plugin-debug": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-debug/-/plugin-debug-3.9.2.tgz", + "integrity": "sha512-j7a5hWuAFxyQAkilZwhsQ/b3T7FfHZ+0dub6j/GxKNFJp2h9qk/P1Bp7vrGASnvA9KNQBBL1ZXTe7jlh4VdPdA==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "fs-extra": "^11.1.1", + "react-json-view-lite": "^2.3.0", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-analytics": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.9.2.tgz", + "integrity": "sha512-mAwwQJ1Us9jL/lVjXtErXto4p4/iaLlweC54yDUK1a97WfkC6Z2k5/769JsFgwOwOP+n5mUQGACXOEQ0XDuVUw==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-gtag": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.9.2.tgz", + "integrity": "sha512-YJ4lDCphabBtw19ooSlc1MnxtYGpjFV9rEdzjLsUnBCeis2djUyCozZaFhCg6NGEwOn7HDDyMh0yzcdRpnuIvA==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@types/gtag.js": "^0.0.12", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-tag-manager": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.9.2.tgz", + "integrity": "sha512-LJtIrkZN/tuHD8NqDAW1Tnw0ekOwRTfobWPsdO15YxcicBo2ykKF0/D6n0vVBfd3srwr9Z6rzrIWYrMzBGrvNw==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-sitemap": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.9.2.tgz", + "integrity": "sha512-WLh7ymgDXjG8oPoM/T4/zUP7KcSuFYRZAUTl8vR6VzYkfc18GBM4xLhcT+AKOwun6kBivYKUJf+vlqYJkm+RHw==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "fs-extra": "^11.1.1", + "sitemap": "^7.1.1", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/plugin-svgr": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-svgr/-/plugin-svgr-3.9.2.tgz", + "integrity": "sha512-n+1DE+5b3Lnf27TgVU5jM1d4x5tUh2oW5LTsBxJX4PsAPV0JGcmI6p3yLYtEY0LRVEIJh+8RsdQmRE66wSV8mw==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@svgr/core": "8.1.0", + "@svgr/webpack": "^8.1.0", + "tslib": "^2.6.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/preset-classic": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/preset-classic/-/preset-classic-3.9.2.tgz", + "integrity": "sha512-IgyYO2Gvaigi21LuDIe+nvmN/dfGXAiMcV/murFqcpjnZc7jxFAxW+9LEjdPt61uZLxG4ByW/oUmX/DDK9t/8w==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/plugin-content-blog": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/plugin-content-pages": "3.9.2", + "@docusaurus/plugin-css-cascade-layers": "3.9.2", + "@docusaurus/plugin-debug": "3.9.2", + "@docusaurus/plugin-google-analytics": "3.9.2", + "@docusaurus/plugin-google-gtag": "3.9.2", + "@docusaurus/plugin-google-tag-manager": "3.9.2", + "@docusaurus/plugin-sitemap": "3.9.2", + "@docusaurus/plugin-svgr": "3.9.2", + "@docusaurus/theme-classic": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-search-algolia": "3.9.2", + "@docusaurus/types": "3.9.2" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/theme-classic": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-classic/-/theme-classic-3.9.2.tgz", + "integrity": "sha512-IGUsArG5hhekXd7RDb11v94ycpJpFdJPkLnt10fFQWOVxAtq5/D7hT6lzc2fhyQKaaCE62qVajOMKL7OiAFAIA==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/plugin-content-blog": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/plugin-content-pages": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "infima": "0.2.0-alpha.45", + "lodash": "^4.17.21", + "nprogress": "^0.2.0", + "postcss": "^8.5.4", + "prism-react-renderer": "^2.3.0", + "prismjs": "^1.29.0", + "react-router-dom": "^5.3.4", + "rtlcss": "^4.1.0", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/theme-common": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.9.2.tgz", + "integrity": "sha512-6c4DAbR6n6nPbnZhY2V3tzpnKnGL+6aOsLvFL26VRqhlczli9eWG0VDUNoCQEPnGwDMhPS42UhSAnz5pThm5Ag==", + "license": "MIT", + "dependencies": { + "@docusaurus/mdx-loader": "3.9.2", + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router-config": "*", + "clsx": "^2.0.0", + "parse-numeric-range": "^1.3.0", + "prism-react-renderer": "^2.3.0", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "@docusaurus/plugin-content-docs": "*", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/theme-search-algolia": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.9.2.tgz", + "integrity": "sha512-GBDSFNwjnh5/LdkxCKQHkgO2pIMX1447BxYUBG2wBiajS21uj64a+gH/qlbQjDLxmGrbrllBrtJkUHxIsiwRnw==", + "license": "MIT", + "dependencies": { + "@docsearch/react": "^3.9.0 || ^4.1.0", + "@docusaurus/core": "3.9.2", + "@docusaurus/logger": "3.9.2", + "@docusaurus/plugin-content-docs": "3.9.2", + "@docusaurus/theme-common": "3.9.2", + "@docusaurus/theme-translations": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-validation": "3.9.2", + "algoliasearch": "^5.37.0", + "algoliasearch-helper": "^3.26.0", + "clsx": "^2.0.0", + "eta": "^2.2.0", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/theme-translations": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-translations/-/theme-translations-3.9.2.tgz", + "integrity": "sha512-vIryvpP18ON9T9rjgMRFLr2xJVDpw1rtagEGf8Ccce4CkTrvM/fRB8N2nyWYOW5u3DdjkwKw5fBa+3tbn9P4PA==", + "license": "MIT", + "dependencies": { + "fs-extra": "^11.1.1", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/tsconfig": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/tsconfig/-/tsconfig-3.9.2.tgz", + "integrity": "sha512-j6/Fp4Rlpxsc632cnRnl5HpOWeb6ZKssDj6/XzzAzVGXXfm9Eptx3rxCC+fDzySn9fHTS+CWJjPineCR1bB5WQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@docusaurus/types": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/types/-/types-3.9.2.tgz", + "integrity": "sha512-Ux1JUNswg+EfUEmajJjyhIohKceitY/yzjRUpu04WXgvVz+fbhVC0p+R0JhvEu4ytw8zIAys2hrdpQPBHRIa8Q==", + "license": "MIT", + "dependencies": { + "@mdx-js/mdx": "^3.0.0", + "@types/history": "^4.7.11", + "@types/mdast": "^4.0.2", + "@types/react": "*", + "commander": "^5.1.0", + "joi": "^17.9.2", + "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", + "utility-types": "^3.10.0", + "webpack": "^5.95.0", + "webpack-merge": "^5.9.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/@docusaurus/types/node_modules/webpack-merge": { + "version": "5.10.0", + "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz", + "integrity": "sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA==", + "license": "MIT", + "dependencies": { + "clone-deep": "^4.0.1", + "flat": "^5.0.2", + "wildcard": "^2.0.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/@docusaurus/utils": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/utils/-/utils-3.9.2.tgz", + "integrity": "sha512-lBSBiRruFurFKXr5Hbsl2thmGweAPmddhF3jb99U4EMDA5L+e5Y1rAkOS07Nvrup7HUMBDrCV45meaxZnt28nQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/logger": "3.9.2", + "@docusaurus/types": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "escape-string-regexp": "^4.0.0", + "execa": "5.1.1", + "file-loader": "^6.2.0", + "fs-extra": "^11.1.1", + "github-slugger": "^1.5.0", + "globby": "^11.1.0", + "gray-matter": "^4.0.3", + "jiti": "^1.20.0", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "micromatch": "^4.0.5", + "p-queue": "^6.6.2", + "prompts": "^2.4.2", + "resolve-pathname": "^3.0.0", + "tslib": "^2.6.0", + "url-loader": "^4.1.1", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/utils-common": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/utils-common/-/utils-common-3.9.2.tgz", + "integrity": "sha512-I53UC1QctruA6SWLvbjbhCpAw7+X7PePoe5pYcwTOEXD/PxeP8LnECAhTHHwWCblyUX5bMi4QLRkxvyZ+IT8Aw==", + "license": "MIT", + "dependencies": { + "@docusaurus/types": "3.9.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@docusaurus/utils-validation": { + "version": "3.9.2", + "resolved": "https://registry.npmjs.org/@docusaurus/utils-validation/-/utils-validation-3.9.2.tgz", + "integrity": "sha512-l7yk3X5VnNmATbwijJkexdhulNsQaNDwoagiwujXoxFbWLcxHQqNQ+c/IAlzrfMMOfa/8xSBZ7KEKDesE/2J7A==", + "license": "MIT", + "dependencies": { + "@docusaurus/logger": "3.9.2", + "@docusaurus/utils": "3.9.2", + "@docusaurus/utils-common": "3.9.2", + "fs-extra": "^11.2.0", + "joi": "^17.9.2", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@easyops-cn/autocomplete.js": { + "version": "0.38.1", + "resolved": "https://registry.npmjs.org/@easyops-cn/autocomplete.js/-/autocomplete.js-0.38.1.tgz", + "integrity": "sha512-drg76jS6syilOUmVNkyo1c7ZEBPcPuK+aJA7AksM5ZIIbV57DMHCywiCr+uHyv8BE5jUTU98j/H7gVrkHrWW3Q==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "immediate": "^3.2.3" + } + }, + "node_modules/@easyops-cn/docusaurus-search-local": { + "version": "0.55.1", + "resolved": "https://registry.npmjs.org/@easyops-cn/docusaurus-search-local/-/docusaurus-search-local-0.55.1.tgz", + "integrity": "sha512-jmBKj1J+tajqNrCvECwKCQYTWwHVZDGApy8lLOYEPe+Dm0/f3Ccdw8BP5/OHNpltr7WDNY2roQXn+TWn2f1kig==", + "license": "MIT", + "dependencies": { + "@docusaurus/plugin-content-docs": "^2 || ^3", + "@docusaurus/theme-translations": "^2 || ^3", + "@docusaurus/utils": "^2 || ^3", + "@docusaurus/utils-common": "^2 || ^3", + "@docusaurus/utils-validation": "^2 || ^3", + "@easyops-cn/autocomplete.js": "^0.38.1", + "@node-rs/jieba": "^1.6.0", + "cheerio": "^1.0.0", + "clsx": "^2.1.1", + "comlink": "^4.4.2", + "debug": "^4.2.0", + "fs-extra": "^10.0.0", + "klaw-sync": "^6.0.0", + "lunr": "^2.3.9", + "lunr-languages": "^1.4.0", + "mark.js": "^8.11.1", + "tslib": "^2.4.0" + }, + "engines": { + "node": ">=12" + }, + "peerDependencies": { + "@docusaurus/theme-common": "^2 || ^3", + "open-ask-ai": "^0.7.3", + "react": "^16.14.0 || ^17 || ^18 || ^19", + "react-dom": "^16.14.0 || 17 || ^18 || ^19" + }, + "peerDependenciesMeta": { + "open-ask-ai": { + "optional": true + } + } + }, + "node_modules/@easyops-cn/docusaurus-search-local/node_modules/cheerio": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.2.0.tgz", + "integrity": "sha512-WDrybc/gKFpTYQutKIK6UvfcuxijIZfMfXaYm8NMsPQxSYvf+13fXUJ4rztGGbJcBQ/GF55gvrZ0Bc0bj/mqvg==", + "license": "MIT", + "dependencies": { + "cheerio-select": "^2.1.0", + "dom-serializer": "^2.0.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.2", + "encoding-sniffer": "^0.2.1", + "htmlparser2": "^10.1.0", + "parse5": "^7.3.0", + "parse5-htmlparser2-tree-adapter": "^7.1.0", + "parse5-parser-stream": "^7.1.2", + "undici": "^7.19.0", + "whatwg-mimetype": "^4.0.0" + }, + "engines": { + "node": ">=20.18.1" + }, + "funding": { + "url": "https://github.com/cheeriojs/cheerio?sponsor=1" + } + }, + "node_modules/@easyops-cn/docusaurus-search-local/node_modules/entities": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz", + "integrity": "sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/@easyops-cn/docusaurus-search-local/node_modules/fs-extra": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", + "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@easyops-cn/docusaurus-search-local/node_modules/htmlparser2": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.1.0.tgz", + "integrity": "sha512-VTZkM9GWRAtEpveh7MSF6SjjrpNVNNVJfFup7xTY3UpFtm67foy9HDVXneLtFVt4pMz5kZtgNcvCniNFb1hlEQ==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.2", + "entities": "^7.0.1" + } + }, + "node_modules/@emnapi/core": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.9.1.tgz", + "integrity": "sha512-mukuNALVsoix/w1BJwFzwXBN/dHeejQtuVzcDsfOEsdpCumXb/E9j8w11h5S54tT1xhifGfbbSm/ICrObRb3KA==", + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/wasi-threads": "1.2.0", + "tslib": "^2.4.0" + } + }, + "node_modules/@emnapi/runtime": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.9.1.tgz", + "integrity": "sha512-VYi5+ZVLhpgK4hQ0TAjiQiZ6ol0oe4mBx7mVv7IflsiEp0OWoVsp/+f9Vc1hOhE0TtkORVrI1GvzyreqpgWtkA==", + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@emnapi/wasi-threads": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.2.0.tgz", + "integrity": "sha512-N10dEJNSsUx41Z6pZsXU8FjPjpBEplgH24sfkmITrBED1/U2Esum9F3lfLrMjKHHjmi557zQn7kR9R+XWXu5Rg==", + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@gerrit0/mini-shiki": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.23.0.tgz", + "integrity": "sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-oniguruma": "^3.23.0", + "@shikijs/langs": "^3.23.0", + "@shikijs/themes": "^3.23.0", + "@shikijs/types": "^3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@hapi/hoek": { + "version": "9.3.0", + "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", + "integrity": "sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==", + "license": "BSD-3-Clause" + }, + "node_modules/@hapi/topo": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@hapi/topo/-/topo-5.1.0.tgz", + "integrity": "sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==", + "license": "BSD-3-Clause", + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@jest/schemas": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", + "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", + "license": "MIT", + "dependencies": { + "@sinclair/typebox": "^0.27.8" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/types": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.6.3.tgz", + "integrity": "sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==", + "license": "MIT", + "dependencies": { + "@jest/schemas": "^29.6.3", + "@types/istanbul-lib-coverage": "^2.0.0", + "@types/istanbul-reports": "^3.0.0", + "@types/node": "*", + "@types/yargs": "^17.0.8", + "chalk": "^4.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/remapping": { + "version": "2.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/remapping/-/remapping-2.3.5.tgz", + "integrity": "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==", + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/source-map": { + "version": "0.3.11", + "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.11.tgz", + "integrity": "sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA==", + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@jsonjoy.com/base64": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/base64/-/base64-1.1.2.tgz", + "integrity": "sha512-q6XAnWQDIMA3+FTiOYajoYqySkO+JSat0ytXGSuRdq9uXE7o92gzuQwQM14xaCRlBLGq3v5miDGC4vkVTn54xA==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/buffers": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-17.67.0.tgz", + "integrity": "sha512-tfExRpYxBvi32vPs9ZHaTjSP4fHAfzSmcahOfNxtvGHcyJel+aibkPlGeBB+7AoC6hL7lXIE++8okecBxx7lcw==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/codegen": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/codegen/-/codegen-1.0.0.tgz", + "integrity": "sha512-E8Oy+08cmCf0EK/NMxpaJZmOxPqM+6iSe2S4nlSBrPZOORoDJILxtbSUEDKQyTamm/BVAhIGllOBNU79/dwf0g==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-core": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-core/-/fs-core-4.57.1.tgz", + "integrity": "sha512-YrEi/ZPmgc+GfdO0esBF04qv8boK9Dg9WpRQw/+vM8Qt3nnVIJWIa8HwZ/LXVZ0DB11XUROM8El/7yYTJX+WtA==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "thingies": "^2.5.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-fsa": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-fsa/-/fs-fsa-4.57.1.tgz", + "integrity": "sha512-ooEPvSW/HQDivPDPZMibHGKZf/QS4WRir1czGZmXmp3MsQqLECZEpN0JobrD8iV9BzsuwdIv+PxtWX9WpPLsIA==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-core": "4.57.1", + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "thingies": "^2.5.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-node": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node/-/fs-node-4.57.1.tgz", + "integrity": "sha512-3YaKhP8gXEKN+2O49GLNfNb5l2gbnCFHyAaybbA2JkkbQP3dpdef7WcUaHAulg/c5Dg4VncHsA3NWAUSZMR5KQ==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-core": "4.57.1", + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "@jsonjoy.com/fs-print": "4.57.1", + "@jsonjoy.com/fs-snapshot": "4.57.1", + "glob-to-regex.js": "^1.0.0", + "thingies": "^2.5.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-node-builtins": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-builtins/-/fs-node-builtins-4.57.1.tgz", + "integrity": "sha512-XHkFKQ5GSH3uxm8c3ZYXVrexGdscpWKIcMWKFQpMpMJc8gA3AwOMBJXJlgpdJqmrhPyQXxaY9nbkNeYpacC0Og==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-node-to-fsa": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-to-fsa/-/fs-node-to-fsa-4.57.1.tgz", + "integrity": "sha512-pqGHyWWzNck4jRfaGV39hkqpY5QjRUQ/nRbNT7FYbBa0xf4bDG+TE1Gt2KWZrSkrkZZDE3qZUjYMbjwSliX6pg==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-fsa": "4.57.1", + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-node-utils": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-node-utils/-/fs-node-utils-4.57.1.tgz", + "integrity": "sha512-vp+7ZzIB8v43G+GLXTS4oDUSQmhAsRz532QmmWBbdYA20s465JvwhkSFvX9cVTqRRAQg+vZ7zWDaIEh0lFe2gw==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-node-builtins": "4.57.1" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-print": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-print/-/fs-print-4.57.1.tgz", + "integrity": "sha512-Ynct7ZJmfk6qoXDOKfpovNA36ITUx8rChLmRQtW08J73VOiuNsU8PB6d/Xs7fxJC2ohWR3a5AqyjmLojfrw5yw==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-node-utils": "4.57.1", + "tree-dump": "^1.1.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/fs-snapshot/-/fs-snapshot-4.57.1.tgz", + "integrity": "sha512-/oG8xBNFMbDXTq9J7vepSA1kerS5vpgd3p5QZSPd+nX59uwodGJftI51gDYyHRpP57P3WCQf7LHtBYPqwUg2Bg==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/buffers": "^17.65.0", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "@jsonjoy.com/json-pack": "^17.65.0", + "@jsonjoy.com/util": "^17.65.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/base64": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/base64/-/base64-17.67.0.tgz", + "integrity": "sha512-5SEsJGsm15aP8TQGkDfJvz9axgPwAEm98S5DxOuYe8e1EbfajcDmgeXXzccEjh+mLnjqEKrkBdjHWS5vFNwDdw==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/codegen": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/codegen/-/codegen-17.67.0.tgz", + "integrity": "sha512-idnkUplROpdBOV0HMcwhsCUS5TRUi9poagdGs70A6S4ux9+/aPuKbh8+UYRTLYQHtXvAdNfQWXDqZEx5k4Dj2Q==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/json-pack": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pack/-/json-pack-17.67.0.tgz", + "integrity": "sha512-t0ejURcGaZsn1ClbJ/3kFqSOjlryd92eQY465IYrezsXmPcfHPE/av4twRSxf6WE+TkZgLY+71vCZbiIiFKA/w==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/base64": "17.67.0", + "@jsonjoy.com/buffers": "17.67.0", + "@jsonjoy.com/codegen": "17.67.0", + "@jsonjoy.com/json-pointer": "17.67.0", + "@jsonjoy.com/util": "17.67.0", + "hyperdyperid": "^1.2.0", + "thingies": "^2.5.0", + "tree-dump": "^1.1.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/json-pointer": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pointer/-/json-pointer-17.67.0.tgz", + "integrity": "sha512-+iqOFInH+QZGmSuaybBUNdh7yvNrXvqR+h3wjXm0N/3JK1EyyFAeGJvqnmQL61d1ARLlk/wJdFKSL+LHJ1eaUA==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/util": "17.67.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/fs-snapshot/node_modules/@jsonjoy.com/util": { + "version": "17.67.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/util/-/util-17.67.0.tgz", + "integrity": "sha512-6+8xBaz1rLSohlGh68D1pdw3AwDi9xydm8QNlAFkvnavCJYSze+pxoW2VKP8p308jtlMRLs5NTHfPlZLd4w7ew==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/buffers": "17.67.0", + "@jsonjoy.com/codegen": "17.67.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/json-pack": { + "version": "1.21.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pack/-/json-pack-1.21.0.tgz", + "integrity": "sha512-+AKG+R2cfZMShzrF2uQw34v3zbeDYUqnQ+jg7ORic3BGtfw9p/+N6RJbq/kkV8JmYZaINknaEQ2m0/f693ZPpg==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/base64": "^1.1.2", + "@jsonjoy.com/buffers": "^1.2.0", + "@jsonjoy.com/codegen": "^1.0.0", + "@jsonjoy.com/json-pointer": "^1.0.2", + "@jsonjoy.com/util": "^1.9.0", + "hyperdyperid": "^1.2.0", + "thingies": "^2.5.0", + "tree-dump": "^1.1.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/json-pack/node_modules/@jsonjoy.com/buffers": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz", + "integrity": "sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/json-pointer": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pointer/-/json-pointer-1.0.2.tgz", + "integrity": "sha512-Fsn6wM2zlDzY1U+v4Nc8bo3bVqgfNTGcn6dMgs6FjrEnt4ZCe60o6ByKRjOGlI2gow0aE/Q41QOigdTqkyK5fg==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/codegen": "^1.0.0", + "@jsonjoy.com/util": "^1.9.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/util": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/util/-/util-1.9.0.tgz", + "integrity": "sha512-pLuQo+VPRnN8hfPqUTLTHk126wuYdXVxE6aDmjSeV4NCAgyxWbiOIeNJVtID3h1Vzpoi9m4jXezf73I6LgabgQ==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/buffers": "^1.0.0", + "@jsonjoy.com/codegen": "^1.0.0" + }, + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@jsonjoy.com/util/node_modules/@jsonjoy.com/buffers": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz", + "integrity": "sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/@leichtgewicht/ip-codec": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz", + "integrity": "sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw==", + "license": "MIT" + }, + "node_modules/@mdx-js/mdx": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@mdx-js/mdx/-/mdx-3.1.1.tgz", + "integrity": "sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdx": "^2.0.0", + "acorn": "^8.0.0", + "collapse-white-space": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-util-scope": "^1.0.0", + "estree-walker": "^3.0.0", + "hast-util-to-jsx-runtime": "^2.0.0", + "markdown-extensions": "^2.0.0", + "recma-build-jsx": "^1.0.0", + "recma-jsx": "^1.0.0", + "recma-stringify": "^1.0.0", + "rehype-recma": "^1.0.0", + "remark-mdx": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.0.0", + "source-map": "^0.7.0", + "unified": "^11.0.0", + "unist-util-position-from-estree": "^2.0.0", + "unist-util-stringify-position": "^4.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/@mdx-js/react": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz", + "integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==", + "license": "MIT", + "dependencies": { + "@types/mdx": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + }, + "peerDependencies": { + "@types/react": ">=16", + "react": ">=16" + } + }, + "node_modules/@napi-rs/wasm-runtime": { + "version": "0.2.12", + "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-0.2.12.tgz", + "integrity": "sha512-ZVWUcfwY4E/yPitQJl481FjFo3K22D6qF0DuFH6Y/nbnE11GY5uguDxZMGXPQ8WQ0128MXQD7TnfHyK4oWoIJQ==", + "license": "MIT", + "optional": true, + "dependencies": { + "@emnapi/core": "^1.4.3", + "@emnapi/runtime": "^1.4.3", + "@tybys/wasm-util": "^0.10.0" + } + }, + "node_modules/@noble/hashes": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@noble/hashes/-/hashes-1.4.0.tgz", + "integrity": "sha512-V1JJ1WTRUqHHrOSh597hURcMqVKVGL/ea3kv0gSnEdsEZ0/+VyPghM1lMNGc00z7CIQorSvbKpuJkxvuHbvdbg==", + "license": "MIT", + "engines": { + "node": ">= 16" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + } + }, + "node_modules/@node-rs/jieba": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba/-/jieba-1.10.4.tgz", + "integrity": "sha512-GvDgi8MnBiyWd6tksojej8anIx18244NmIOc1ovEw8WKNUejcccLfyu8vj66LWSuoZuKILVtNsOy4jvg3aoxIw==", + "license": "MIT", + "engines": { + "node": ">= 10" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/Brooooooklyn" + }, + "optionalDependencies": { + "@node-rs/jieba-android-arm-eabi": "1.10.4", + "@node-rs/jieba-android-arm64": "1.10.4", + "@node-rs/jieba-darwin-arm64": "1.10.4", + "@node-rs/jieba-darwin-x64": "1.10.4", + "@node-rs/jieba-freebsd-x64": "1.10.4", + "@node-rs/jieba-linux-arm-gnueabihf": "1.10.4", + "@node-rs/jieba-linux-arm64-gnu": "1.10.4", + "@node-rs/jieba-linux-arm64-musl": "1.10.4", + "@node-rs/jieba-linux-x64-gnu": "1.10.4", + "@node-rs/jieba-linux-x64-musl": "1.10.4", + "@node-rs/jieba-wasm32-wasi": "1.10.4", + "@node-rs/jieba-win32-arm64-msvc": "1.10.4", + "@node-rs/jieba-win32-ia32-msvc": "1.10.4", + "@node-rs/jieba-win32-x64-msvc": "1.10.4" + } + }, + "node_modules/@node-rs/jieba-android-arm-eabi": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-android-arm-eabi/-/jieba-android-arm-eabi-1.10.4.tgz", + "integrity": "sha512-MhyvW5N3Fwcp385d0rxbCWH42kqDBatQTyP8XbnYbju2+0BO/eTeCCLYj7Agws4pwxn2LtdldXRSKavT7WdzNA==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-android-arm64": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-android-arm64/-/jieba-android-arm64-1.10.4.tgz", + "integrity": "sha512-XyDwq5+rQ+Tk55A+FGi6PtJbzf974oqnpyCcCPzwU3QVXJCa2Rr4Lci+fx8oOpU4plT3GuD+chXMYLsXipMgJA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-darwin-arm64": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-darwin-arm64/-/jieba-darwin-arm64-1.10.4.tgz", + "integrity": "sha512-G++RYEJ2jo0rxF9626KUy90wp06TRUjAsvY/BrIzEOX/ingQYV/HjwQzNPRR1P1o32a6/U8RGo7zEBhfdybL6w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-darwin-x64": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-darwin-x64/-/jieba-darwin-x64-1.10.4.tgz", + "integrity": "sha512-MmDNeOb2TXIZCPyWCi2upQnZpPjAxw5ZGEj6R8kNsPXVFALHIKMa6ZZ15LCOkSTsKXVC17j2t4h+hSuyYb6qfQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-freebsd-x64": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-freebsd-x64/-/jieba-freebsd-x64-1.10.4.tgz", + "integrity": "sha512-/x7aVQ8nqUWhpXU92RZqd333cq639i/olNpd9Z5hdlyyV5/B65LLy+Je2B2bfs62PVVm5QXRpeBcZqaHelp/bg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-arm-gnueabihf": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm-gnueabihf/-/jieba-linux-arm-gnueabihf-1.10.4.tgz", + "integrity": "sha512-crd2M35oJBRLkoESs0O6QO3BBbhpv+tqXuKsqhIG94B1d02RVxtRIvSDwO33QurxqSdvN9IeSnVpHbDGkuXm3g==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-arm64-gnu": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm64-gnu/-/jieba-linux-arm64-gnu-1.10.4.tgz", + "integrity": "sha512-omIzNX1psUzPcsdnUhGU6oHeOaTCuCjUgOA/v/DGkvWC1jLcnfXe4vdYbtXMh4XOCuIgS1UCcvZEc8vQLXFbXQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-arm64-musl": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm64-musl/-/jieba-linux-arm64-musl-1.10.4.tgz", + "integrity": "sha512-Y/tiJ1+HeS5nnmLbZOE+66LbsPOHZ/PUckAYVeLlQfpygLEpLYdlh0aPpS5uiaWMjAXYZYdFkpZHhxDmSLpwpw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-x64-gnu": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-x64-gnu/-/jieba-linux-x64-gnu-1.10.4.tgz", + "integrity": "sha512-WZO8ykRJpWGE9MHuZpy1lu3nJluPoeB+fIJJn5CWZ9YTVhNDWoCF4i/7nxz1ntulINYGQ8VVuCU9LD86Mek97g==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-linux-x64-musl": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-x64-musl/-/jieba-linux-x64-musl-1.10.4.tgz", + "integrity": "sha512-uBBD4S1rGKcgCyAk6VCKatEVQb6EDD5I40v/DxODi5CuZVCANi9m5oee/MQbAoaX7RydA2f0OSCE9/tcwXEwUg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-wasm32-wasi": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-wasm32-wasi/-/jieba-wasm32-wasi-1.10.4.tgz", + "integrity": "sha512-Y2umiKHjuIJy0uulNDz9SDYHdfq5Hmy7jY5nORO99B4pySKkcrMjpeVrmWXJLIsEKLJwcCXHxz8tjwU5/uhz0A==", + "cpu": [ + "wasm32" + ], + "license": "MIT", + "optional": true, + "dependencies": { + "@napi-rs/wasm-runtime": "^0.2.3" + }, + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/@node-rs/jieba-win32-arm64-msvc": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-arm64-msvc/-/jieba-win32-arm64-msvc-1.10.4.tgz", + "integrity": "sha512-nwMtViFm4hjqhz1it/juQnxpXgqlGltCuWJ02bw70YUDMDlbyTy3grCJPpQQpueeETcALUnTxda8pZuVrLRcBA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-win32-ia32-msvc": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-ia32-msvc/-/jieba-win32-ia32-msvc-1.10.4.tgz", + "integrity": "sha512-DCAvLx7Z+W4z5oKS+7vUowAJr0uw9JBw8x1Y23Xs/xMA4Em+OOSiaF5/tCJqZUCJ8uC4QeImmgDFiBqGNwxlyA==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@node-rs/jieba-win32-x64-msvc": { + "version": "1.10.4", + "resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-x64-msvc/-/jieba-win32-x64-msvc-1.10.4.tgz", + "integrity": "sha512-+sqemSfS1jjb+Tt7InNbNzrRh1Ua3vProVvC4BZRPg010/leCbGFFiQHpzcPRfpxAXZrzG5Y0YBTsPzN/I4yHQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">= 10" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@peculiar/asn1-cms": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-cms/-/asn1-cms-2.6.1.tgz", + "integrity": "sha512-vdG4fBF6Lkirkcl53q6eOdn3XYKt+kJTG59edgRZORlg/3atWWEReRCx5rYE1ZzTTX6vLK5zDMjHh7vbrcXGtw==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "@peculiar/asn1-x509-attr": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-csr": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-csr/-/asn1-csr-2.6.1.tgz", + "integrity": "sha512-WRWnKfIocHyzFYQTka8O/tXCiBquAPSrRjXbOkHbO4qdmS6loffCEGs+rby6WxxGdJCuunnhS2duHURhjyio6w==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-ecc": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-ecc/-/asn1-ecc-2.6.1.tgz", + "integrity": "sha512-+Vqw8WFxrtDIN5ehUdvlN2m73exS2JVG0UAyfVB31gIfor3zWEAQPD+K9ydCxaj3MLen9k0JhKpu9LqviuCE1g==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-pfx": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-pfx/-/asn1-pfx-2.6.1.tgz", + "integrity": "sha512-nB5jVQy3MAAWvq0KY0R2JUZG8bO/bTLpnwyOzXyEh/e54ynGTatAR+csOnXkkVD9AFZ2uL8Z7EV918+qB1qDvw==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-cms": "^2.6.1", + "@peculiar/asn1-pkcs8": "^2.6.1", + "@peculiar/asn1-rsa": "^2.6.1", + "@peculiar/asn1-schema": "^2.6.0", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-pkcs8": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-pkcs8/-/asn1-pkcs8-2.6.1.tgz", + "integrity": "sha512-JB5iQ9Izn5yGMw3ZG4Nw3Xn/hb/G38GYF3lf7WmJb8JZUydhVGEjK/ZlFSWhnlB7K/4oqEs8HnfFIKklhR58Tw==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-pkcs9": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-pkcs9/-/asn1-pkcs9-2.6.1.tgz", + "integrity": "sha512-5EV8nZoMSxeWmcxWmmcolg22ojZRgJg+Y9MX2fnE2bGRo5KQLqV5IL9kdSQDZxlHz95tHvIq9F//bvL1OeNILw==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-cms": "^2.6.1", + "@peculiar/asn1-pfx": "^2.6.1", + "@peculiar/asn1-pkcs8": "^2.6.1", + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "@peculiar/asn1-x509-attr": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-rsa": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-rsa/-/asn1-rsa-2.6.1.tgz", + "integrity": "sha512-1nVMEh46SElUt5CB3RUTV4EG/z7iYc7EoaDY5ECwganibQPkZ/Y2eMsTKB/LeyrUJ+W/tKoD9WUqIy8vB+CEdA==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-schema": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-schema/-/asn1-schema-2.6.0.tgz", + "integrity": "sha512-xNLYLBFTBKkCzEZIw842BxytQQATQv+lDTCEMZ8C196iJcJJMBUZxrhSTxLaohMyKK8QlzRNTRkUmanucnDSqg==", + "license": "MIT", + "dependencies": { + "asn1js": "^3.0.6", + "pvtsutils": "^1.3.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-x509": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-x509/-/asn1-x509-2.6.1.tgz", + "integrity": "sha512-O9jT5F1A2+t3r7C4VT7LYGXqkGLK7Kj1xFpz7U0isPrubwU5PbDoyYtx6MiGst29yq7pXN5vZbQFKRCP+lLZlA==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "asn1js": "^3.0.6", + "pvtsutils": "^1.3.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/asn1-x509-attr": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/@peculiar/asn1-x509-attr/-/asn1-x509-attr-2.6.1.tgz", + "integrity": "sha512-tlW6cxoHwgcQghnJwv3YS+9OO1737zgPogZ+CgWRUK4roEwIPzRH4JEiG770xe5HX2ATfCpmX60gurfWIF9dcQ==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.1", + "asn1js": "^3.0.6", + "tslib": "^2.8.1" + } + }, + "node_modules/@peculiar/x509": { + "version": "1.14.3", + "resolved": "https://registry.npmjs.org/@peculiar/x509/-/x509-1.14.3.tgz", + "integrity": "sha512-C2Xj8FZ0uHWeCXXqX5B4/gVFQmtSkiuOolzAgutjTfseNOHT3pUjljDZsTSxXFGgio54bCzVFqmEOUrIVk8RDA==", + "license": "MIT", + "dependencies": { + "@peculiar/asn1-cms": "^2.6.0", + "@peculiar/asn1-csr": "^2.6.0", + "@peculiar/asn1-ecc": "^2.6.0", + "@peculiar/asn1-pkcs9": "^2.6.0", + "@peculiar/asn1-rsa": "^2.6.0", + "@peculiar/asn1-schema": "^2.6.0", + "@peculiar/asn1-x509": "^2.6.0", + "pvtsutils": "^1.3.6", + "reflect-metadata": "^0.2.2", + "tslib": "^2.8.1", + "tsyringe": "^4.10.0" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@pnpm/config.env-replace": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz", + "integrity": "sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w==", + "license": "MIT", + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.2.tgz", + "integrity": "sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA==", + "license": "MIT", + "dependencies": { + "graceful-fs": "4.2.10" + }, + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file/node_modules/graceful-fs": { + "version": "4.2.10", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", + "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", + "license": "ISC" + }, + "node_modules/@pnpm/npm-conf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-3.0.2.tgz", + "integrity": "sha512-h104Kh26rR8tm+a3Qkc5S4VLYint3FE48as7+/5oCEcKR2idC/pF1G6AhIXKI+eHPJa/3J9i5z0Al47IeGHPkA==", + "license": "MIT", + "dependencies": { + "@pnpm/config.env-replace": "^1.1.0", + "@pnpm/network.ca-file": "^1.0.1", + "config-chain": "^1.1.11" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@polka/url": { + "version": "1.0.0-next.29", + "resolved": "https://registry.npmjs.org/@polka/url/-/url-1.0.0-next.29.tgz", + "integrity": "sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww==", + "license": "MIT" + }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz", + "integrity": "sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.23.0.tgz", + "integrity": "sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.23.0.tgz", + "integrity": "sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.23.0.tgz", + "integrity": "sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@sideway/address": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz", + "integrity": "sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q==", + "license": "BSD-3-Clause", + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@sideway/formula": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@sideway/formula/-/formula-3.0.1.tgz", + "integrity": "sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg==", + "license": "BSD-3-Clause" + }, + "node_modules/@sideway/pinpoint": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@sideway/pinpoint/-/pinpoint-2.0.0.tgz", + "integrity": "sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ==", + "license": "BSD-3-Clause" + }, + "node_modules/@sinclair/typebox": { + "version": "0.27.10", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.10.tgz", + "integrity": "sha512-MTBk/3jGLNB2tVxv6uLlFh1iu64iYOQ2PbdOSK3NW8JZsmlaOh2q6sdtKowBhfw8QFLmYNzTW4/oK4uATIi6ZA==", + "license": "MIT" + }, + "node_modules/@sindresorhus/is": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", + "integrity": "sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/is?sponsor=1" + } + }, + "node_modules/@slorber/remark-comment": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@slorber/remark-comment/-/remark-comment-1.0.0.tgz", + "integrity": "sha512-RCE24n7jsOj1M0UPvIQCHTe7fI0sFL4S2nwKVWwHyVr/wI/H8GosgsJGyhnsZoGFnD/P2hLf1mSbrrgSLN93NA==", + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^1.0.0", + "micromark-util-character": "^1.1.0", + "micromark-util-symbol": "^1.0.1" + } + }, + "node_modules/@svgr/babel-plugin-add-jsx-attribute": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz", + "integrity": "sha512-b9MIk7yhdS1pMCZM8VeNfUlSKVRhsHZNMl5O9SfaX0l0t5wjdgu4IDzGB8bpnGBBOjGST3rRFVsaaEtI4W6f7g==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-remove-jsx-attribute": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-attribute/-/babel-plugin-remove-jsx-attribute-8.0.0.tgz", + "integrity": "sha512-BcCkm/STipKvbCl6b7QFrMh/vx00vIP63k2eM66MfHJzPr6O2U0jYEViXkHJWqXqQYjdeA9cuCl5KWmlwjDvbA==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-remove-jsx-empty-expression": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-empty-expression/-/babel-plugin-remove-jsx-empty-expression-8.0.0.tgz", + "integrity": "sha512-5BcGCBfBxB5+XSDSWnhTThfI9jcO5f0Ai2V24gZpG+wXF14BzwxxdDb4g6trdOux0rhibGs385BeFMSmxtS3uA==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-replace-jsx-attribute-value": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-replace-jsx-attribute-value/-/babel-plugin-replace-jsx-attribute-value-8.0.0.tgz", + "integrity": "sha512-KVQ+PtIjb1BuYT3ht8M5KbzWBhdAjjUPdlMtpuw/VjT8coTrItWX6Qafl9+ji831JaJcu6PJNKCV0bp01lBNzQ==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-svg-dynamic-title": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-dynamic-title/-/babel-plugin-svg-dynamic-title-8.0.0.tgz", + "integrity": "sha512-omNiKqwjNmOQJ2v6ge4SErBbkooV2aAWwaPFs2vUY7p7GhVkzRkJ00kILXQvRhA6miHnNpXv7MRnnSjdRjK8og==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-svg-em-dimensions": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-em-dimensions/-/babel-plugin-svg-em-dimensions-8.0.0.tgz", + "integrity": "sha512-mURHYnu6Iw3UBTbhGwE/vsngtCIbHE43xCRK7kCw4t01xyGqb2Pd+WXekRRoFOBIY29ZoOhUCTEweDMdrjfi9g==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-transform-react-native-svg": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-react-native-svg/-/babel-plugin-transform-react-native-svg-8.1.0.tgz", + "integrity": "sha512-Tx8T58CHo+7nwJ+EhUwx3LfdNSG9R2OKfaIXXs5soiy5HtgoAEkDay9LIimLOcG8dJQH1wPZp/cnAv6S9CrR1Q==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-transform-svg-component": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-svg-component/-/babel-plugin-transform-svg-component-8.0.0.tgz", + "integrity": "sha512-DFx8xa3cZXTdb/k3kfPeaixecQLgKh5NVBMwD0AQxOzcZawK4oo1Jh9LbrcACUivsCA7TLG8eeWgrDXjTMhRmw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-preset": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-preset/-/babel-preset-8.1.0.tgz", + "integrity": "sha512-7EYDbHE7MxHpv4sxvnVPngw5fuR6pw79SkcrILHJ/iMpuKySNCl5W1qcwPEpU+LgyRXOaAFgH0KhwD18wwg6ug==", + "license": "MIT", + "dependencies": { + "@svgr/babel-plugin-add-jsx-attribute": "8.0.0", + "@svgr/babel-plugin-remove-jsx-attribute": "8.0.0", + "@svgr/babel-plugin-remove-jsx-empty-expression": "8.0.0", + "@svgr/babel-plugin-replace-jsx-attribute-value": "8.0.0", + "@svgr/babel-plugin-svg-dynamic-title": "8.0.0", + "@svgr/babel-plugin-svg-em-dimensions": "8.0.0", + "@svgr/babel-plugin-transform-react-native-svg": "8.1.0", + "@svgr/babel-plugin-transform-svg-component": "8.0.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/core": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", + "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.21.3", + "@svgr/babel-preset": "8.1.0", + "camelcase": "^6.2.0", + "cosmiconfig": "^8.1.3", + "snake-case": "^3.0.4" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@svgr/hast-util-to-babel-ast": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/hast-util-to-babel-ast/-/hast-util-to-babel-ast-8.0.0.tgz", + "integrity": "sha512-EbDKwO9GpfWP4jN9sGdYwPBU0kdomaPIL2Eu4YwmgP+sJeXT+L7bMwJUBnhzfH8Q2qMBqZ4fJwpCyYsAN3mt2Q==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.21.3", + "entities": "^4.4.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@svgr/plugin-jsx": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/plugin-jsx/-/plugin-jsx-8.1.0.tgz", + "integrity": "sha512-0xiIyBsLlr8quN+WyuxooNW9RJ0Dpr8uOnH/xrCVO8GLUcwHISwj1AG0k+LFzteTkAA0GbX0kj9q6Dk70PTiPA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.21.3", + "@svgr/babel-preset": "8.1.0", + "@svgr/hast-util-to-babel-ast": "8.0.0", + "svg-parser": "^2.0.4" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@svgr/core": "*" + } + }, + "node_modules/@svgr/plugin-svgo": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/plugin-svgo/-/plugin-svgo-8.1.0.tgz", + "integrity": "sha512-Ywtl837OGO9pTLIN/onoWLmDQ4zFUycI1g76vuKGEz6evR/ZTJlJuz3G/fIkb6OVBJ2g0o6CGJzaEjfmEo3AHA==", + "license": "MIT", + "dependencies": { + "cosmiconfig": "^8.1.3", + "deepmerge": "^4.3.1", + "svgo": "^3.0.2" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@svgr/core": "*" + } + }, + "node_modules/@svgr/webpack": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/webpack/-/webpack-8.1.0.tgz", + "integrity": "sha512-LnhVjMWyMQV9ZmeEy26maJk+8HTIbd59cH4F2MJ439k9DqejRisfFNGAPvRYlKETuh9LrImlS8aKsBgKjMA8WA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.21.3", + "@babel/plugin-transform-react-constant-elements": "^7.21.3", + "@babel/preset-env": "^7.20.2", + "@babel/preset-react": "^7.18.6", + "@babel/preset-typescript": "^7.21.0", + "@svgr/core": "8.1.0", + "@svgr/plugin-jsx": "8.1.0", + "@svgr/plugin-svgo": "8.1.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@szmarczak/http-timer": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-5.0.1.tgz", + "integrity": "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==", + "license": "MIT", + "dependencies": { + "defer-to-connect": "^2.0.1" + }, + "engines": { + "node": ">=14.16" + } + }, + "node_modules/@tybys/wasm-util": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.1.tgz", + "integrity": "sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg==", + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@types/body-parser": { + "version": "1.19.6", + "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.6.tgz", + "integrity": "sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g==", + "license": "MIT", + "dependencies": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "node_modules/@types/bonjour": { + "version": "3.5.13", + "resolved": "https://registry.npmjs.org/@types/bonjour/-/bonjour-3.5.13.tgz", + "integrity": "sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect": { + "version": "3.4.38", + "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", + "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect-history-api-fallback": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz", + "integrity": "sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw==", + "license": "MIT", + "dependencies": { + "@types/express-serve-static-core": "*", + "@types/node": "*" + } + }, + "node_modules/@types/debug": { + "version": "4.1.13", + "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.13.tgz", + "integrity": "sha512-KSVgmQmzMwPlmtljOomayoR89W4FynCAi3E8PPs7vmDVPe84hT+vGPKkJfThkmXs0x0jAaa9U8uW8bbfyS2fWw==", + "license": "MIT", + "dependencies": { + "@types/ms": "*" + } + }, + "node_modules/@types/eslint": { + "version": "9.6.1", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-9.6.1.tgz", + "integrity": "sha512-FXx2pKgId/WyYo2jXw63kk7/+TY7u7AziEJxJAnSFzHlqTAS3Ync6SvgYAN/k4/PQpnnVuzoMuVnByKK2qp0ag==", + "license": "MIT", + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + } + }, + "node_modules/@types/eslint-scope": { + "version": "3.7.7", + "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.7.tgz", + "integrity": "sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg==", + "license": "MIT", + "dependencies": { + "@types/eslint": "*", + "@types/estree": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "license": "MIT" + }, + "node_modules/@types/estree-jsx": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree-jsx/-/estree-jsx-1.0.5.tgz", + "integrity": "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg==", + "license": "MIT", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/@types/express": { + "version": "4.17.25", + "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.25.tgz", + "integrity": "sha512-dVd04UKsfpINUnK0yBoYHDF3xu7xVH4BuDotC/xGuycx4CgbP48X/KF/586bcObxT0HENHXEU8Nqtu6NR+eKhw==", + "license": "MIT", + "dependencies": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.33", + "@types/qs": "*", + "@types/serve-static": "^1" + } + }, + "node_modules/@types/express-serve-static-core": { + "version": "4.19.8", + "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.8.tgz", + "integrity": "sha512-02S5fmqeoKzVZCHPZid4b8JH2eM5HzQLZWN2FohQEy/0eXTq8VXZfSN6Pcr3F6N9R/vNrj7cpgbhjie6m/1tCA==", + "license": "MIT", + "dependencies": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*", + "@types/send": "*" + } + }, + "node_modules/@types/gtag.js": { + "version": "0.0.12", + "resolved": "https://registry.npmjs.org/@types/gtag.js/-/gtag.js-0.0.12.tgz", + "integrity": "sha512-YQV9bUsemkzG81Ea295/nF/5GijnD2Af7QhEofh7xu+kvCN6RdodgNwwGWXB5GMI3NoyvQo0odNctoH/qLMIpg==", + "license": "MIT" + }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/history": { + "version": "4.7.11", + "resolved": "https://registry.npmjs.org/@types/history/-/history-4.7.11.tgz", + "integrity": "sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA==", + "license": "MIT" + }, + "node_modules/@types/html-minifier-terser": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", + "integrity": "sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg==", + "license": "MIT" + }, + "node_modules/@types/http-cache-semantics": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", + "integrity": "sha512-L3LgimLHXtGkWikKnsPg0/VFx9OGZaC+eN1u4r+OB1XRqH3meBIAVC2zr1WdMH+RHmnRkqliQAOHNJ/E0j/e0Q==", + "license": "MIT" + }, + "node_modules/@types/http-errors": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.5.tgz", + "integrity": "sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg==", + "license": "MIT" + }, + "node_modules/@types/http-proxy": { + "version": "1.17.17", + "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.17.tgz", + "integrity": "sha512-ED6LB+Z1AVylNTu7hdzuBqOgMnvG/ld6wGCG8wFnAzKX5uyW2K3WD52v0gnLCTK/VLpXtKckgWuyScYK6cSPaw==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/istanbul-lib-coverage": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", + "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", + "license": "MIT" + }, + "node_modules/@types/istanbul-lib-report": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", + "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-coverage": "*" + } + }, + "node_modules/@types/istanbul-reports": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", + "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-report": "*" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "license": "MIT" + }, + "node_modules/@types/mdast": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", + "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/mdx": { + "version": "2.0.13", + "resolved": "https://registry.npmjs.org/@types/mdx/-/mdx-2.0.13.tgz", + "integrity": "sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw==", + "license": "MIT" + }, + "node_modules/@types/mime": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", + "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==", + "license": "MIT" + }, + "node_modules/@types/ms": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz", + "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==", + "license": "MIT" + }, + "node_modules/@types/node": { + "version": "25.5.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-25.5.0.tgz", + "integrity": "sha512-jp2P3tQMSxWugkCUKLRPVUpGaL5MVFwF8RDuSRztfwgN1wmqJeMSbKlnEtQqU8UrhTmzEmZdu2I6v2dpp7XIxw==", + "license": "MIT", + "dependencies": { + "undici-types": "~7.18.0" + } + }, + "node_modules/@types/prismjs": { + "version": "1.26.6", + "resolved": "https://registry.npmjs.org/@types/prismjs/-/prismjs-1.26.6.tgz", + "integrity": "sha512-vqlvI7qlMvcCBbVe0AKAb4f97//Hy0EBTaiW8AalRnG/xAN5zOiWWyrNqNXeq8+KAuvRewjCVY1+IPxk4RdNYw==", + "license": "MIT" + }, + "node_modules/@types/qs": { + "version": "6.15.0", + "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.15.0.tgz", + "integrity": "sha512-JawvT8iBVWpzTrz3EGw9BTQFg3BQNmwERdKE22vlTxawwtbyUSlMppvZYKLZzB5zgACXdXxbD3m1bXaMqP/9ow==", + "license": "MIT" + }, + "node_modules/@types/range-parser": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz", + "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", + "license": "MIT" + }, + "node_modules/@types/react": { + "version": "19.2.14", + "resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.14.tgz", + "integrity": "sha512-ilcTH/UniCkMdtexkoCN0bI7pMcJDvmQFPvuPvmEaYA/NSfFTAgdUSLAoVjaRJm7+6PvcM+q1zYOwS4wTYMF9w==", + "license": "MIT", + "dependencies": { + "csstype": "^3.2.2" + } + }, + "node_modules/@types/react-router": { + "version": "5.1.20", + "resolved": "https://registry.npmjs.org/@types/react-router/-/react-router-5.1.20.tgz", + "integrity": "sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q==", + "license": "MIT", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*" + } + }, + "node_modules/@types/react-router-config": { + "version": "5.0.11", + "resolved": "https://registry.npmjs.org/@types/react-router-config/-/react-router-config-5.0.11.tgz", + "integrity": "sha512-WmSAg7WgqW7m4x8Mt4N6ZyKz0BubSj/2tVUMsAHp+Yd2AMwcSbeFq9WympT19p5heCFmF97R9eD5uUR/t4HEqw==", + "license": "MIT", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router": "^5.1.0" + } + }, + "node_modules/@types/react-router-dom": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/@types/react-router-dom/-/react-router-dom-5.3.3.tgz", + "integrity": "sha512-kpqnYK4wcdm5UaWI3fLcELopqLrHgLqNsdpHauzlQktfkHL3npOSwtj1Uz9oKBAzs7lFtVkV8j83voAz2D8fhw==", + "license": "MIT", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router": "*" + } + }, + "node_modules/@types/retry": { + "version": "0.12.2", + "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.2.tgz", + "integrity": "sha512-XISRgDJ2Tc5q4TRqvgJtzsRkFYNJzZrhTdtMoGVBttwzzQJkPnS3WWTFc7kuDRoPtPakl+T+OfdEUjYJj7Jbow==", + "license": "MIT" + }, + "node_modules/@types/sax": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.7.tgz", + "integrity": "sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/send": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@types/send/-/send-1.2.1.tgz", + "integrity": "sha512-arsCikDvlU99zl1g69TcAB3mzZPpxgw0UQnaHeC1Nwb015xp8bknZv5rIfri9xTOcMuaVgvabfIRA7PSZVuZIQ==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/serve-index": { + "version": "1.9.4", + "resolved": "https://registry.npmjs.org/@types/serve-index/-/serve-index-1.9.4.tgz", + "integrity": "sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug==", + "license": "MIT", + "dependencies": { + "@types/express": "*" + } + }, + "node_modules/@types/serve-static": { + "version": "1.15.10", + "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.10.tgz", + "integrity": "sha512-tRs1dB+g8Itk72rlSI2ZrW6vZg0YrLI81iQSTkMmOqnqCaNr/8Ek4VwWcN5vZgCYWbg/JJSGBlUaYGAOP73qBw==", + "license": "MIT", + "dependencies": { + "@types/http-errors": "*", + "@types/node": "*", + "@types/send": "<1" + } + }, + "node_modules/@types/serve-static/node_modules/@types/send": { + "version": "0.17.6", + "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.6.tgz", + "integrity": "sha512-Uqt8rPBE8SY0RK8JB1EzVOIZ32uqy8HwdxCnoCOsYrvnswqmFZ/k+9Ikidlk/ImhsdvBsloHbAlewb2IEBV/Og==", + "license": "MIT", + "dependencies": { + "@types/mime": "^1", + "@types/node": "*" + } + }, + "node_modules/@types/sockjs": { + "version": "0.3.36", + "resolved": "https://registry.npmjs.org/@types/sockjs/-/sockjs-0.3.36.tgz", + "integrity": "sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "license": "MIT" + }, + "node_modules/@types/ws": { + "version": "8.18.1", + "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz", + "integrity": "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/yargs": { + "version": "17.0.35", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.35.tgz", + "integrity": "sha512-qUHkeCyQFxMXg79wQfTtfndEC+N9ZZg76HJftDJp+qH2tV7Gj4OJi7l+PiWwJ+pWtW8GwSmqsDj/oymhrTWXjg==", + "license": "MIT", + "dependencies": { + "@types/yargs-parser": "*" + } + }, + "node_modules/@types/yargs-parser": { + "version": "21.0.3", + "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", + "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", + "license": "MIT" + }, + "node_modules/@ungap/structured-clone": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", + "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", + "license": "ISC" + }, + "node_modules/@webassemblyjs/ast": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.14.1.tgz", + "integrity": "sha512-nuBEDgQfm1ccRp/8bCQrx1frohyufl4JlbMMZ4P1wpeOfDhF6FQkxZJ1b/e+PLwr6X1Nhw6OLme5usuBWYBvuQ==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/helper-numbers": "1.13.2", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2" + } + }, + "node_modules/@webassemblyjs/floating-point-hex-parser": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.13.2.tgz", + "integrity": "sha512-6oXyTOzbKxGH4steLbLNOu71Oj+C8Lg34n6CqRvqfS2O71BxY6ByfMDRhBytzknj9yGUPVJ1qIKhRlAwO1AovA==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-api-error": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.13.2.tgz", + "integrity": "sha512-U56GMYxy4ZQCbDZd6JuvvNV/WFildOjsaWD3Tzzvmw/mas3cXzRJPMjP83JqEsgSbyrmaGjBfDtV7KDXV9UzFQ==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-buffer": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.14.1.tgz", + "integrity": "sha512-jyH7wtcHiKssDtFPRB+iQdxlDf96m0E39yb0k5uJVhFGleZFoNw1c4aeIcVUPPbXUVJ94wwnMOAqUHyzoEPVMA==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-numbers": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.13.2.tgz", + "integrity": "sha512-FE8aCmS5Q6eQYcV3gI35O4J789wlQA+7JrqTTpJqn5emA4U2hvwJmvFRC0HODS+3Ye6WioDklgd6scJ3+PLnEA==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/floating-point-hex-parser": "1.13.2", + "@webassemblyjs/helper-api-error": "1.13.2", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/helper-wasm-bytecode": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.13.2.tgz", + "integrity": "sha512-3QbLKy93F0EAIXLh0ogEVR6rOubA9AoZ+WRYhNbFyuB70j3dRdwH9g+qXhLAO0kiYGlg3TxDV+I4rQTr/YNXkA==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-wasm-section": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.14.1.tgz", + "integrity": "sha512-ds5mXEqTJ6oxRoqjhWDU83OgzAYjwsCV8Lo/N+oRsNDmx/ZDpqalmrtgOMkHwxsG0iI//3BwWAErYRHtgn0dZw==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/wasm-gen": "1.14.1" + } + }, + "node_modules/@webassemblyjs/ieee754": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.13.2.tgz", + "integrity": "sha512-4LtOzh58S/5lX4ITKxnAK2USuNEvpdVV9AlgGQb8rJDHaLeHciwG4zlGr0j/SNWlr7x3vO1lDEsuePvtcDNCkw==", + "license": "MIT", + "dependencies": { + "@xtuc/ieee754": "^1.2.0" + } + }, + "node_modules/@webassemblyjs/leb128": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.13.2.tgz", + "integrity": "sha512-Lde1oNoIdzVzdkNEAWZ1dZ5orIbff80YPdHx20mrHwHrVNNTjNr8E3xz9BdpcGqRQbAEa+fkrCb+fRFTl/6sQw==", + "license": "Apache-2.0", + "dependencies": { + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/utf8": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.13.2.tgz", + "integrity": "sha512-3NQWGjKTASY1xV5m7Hr0iPeXD9+RDobLll3T9d2AO+g3my8xy5peVyjSag4I50mR1bBSN/Ct12lo+R9tJk0NZQ==", + "license": "MIT" + }, + "node_modules/@webassemblyjs/wasm-edit": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.14.1.tgz", + "integrity": "sha512-RNJUIQH/J8iA/1NzlE4N7KtyZNHi3w7at7hDjvRNm5rcUXa00z1vRz3glZoULfJ5mpvYhLybmVcwcjGrC1pRrQ==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/helper-wasm-section": "1.14.1", + "@webassemblyjs/wasm-gen": "1.14.1", + "@webassemblyjs/wasm-opt": "1.14.1", + "@webassemblyjs/wasm-parser": "1.14.1", + "@webassemblyjs/wast-printer": "1.14.1" + } + }, + "node_modules/@webassemblyjs/wasm-gen": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.14.1.tgz", + "integrity": "sha512-AmomSIjP8ZbfGQhumkNvgC33AY7qtMCXnN6bL2u2Js4gVCg8fp735aEiMSBbDR7UQIj90n4wKAFUSEd0QN2Ukg==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/ieee754": "1.13.2", + "@webassemblyjs/leb128": "1.13.2", + "@webassemblyjs/utf8": "1.13.2" + } + }, + "node_modules/@webassemblyjs/wasm-opt": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.14.1.tgz", + "integrity": "sha512-PTcKLUNvBqnY2U6E5bdOQcSM+oVP/PmrDY9NzowJjislEjwP/C4an2303MCVS2Mg9d3AJpIGdUFIQQWbPds0Sw==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/wasm-gen": "1.14.1", + "@webassemblyjs/wasm-parser": "1.14.1" + } + }, + "node_modules/@webassemblyjs/wasm-parser": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.14.1.tgz", + "integrity": "sha512-JLBl+KZ0R5qB7mCnud/yyX08jWFw5MsoalJ1pQ4EdFlgj9VdXKGuENGsiCIjegI1W7p91rUlcB/LB5yRJKNTcQ==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-api-error": "1.13.2", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/ieee754": "1.13.2", + "@webassemblyjs/leb128": "1.13.2", + "@webassemblyjs/utf8": "1.13.2" + } + }, + "node_modules/@webassemblyjs/wast-printer": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.14.1.tgz", + "integrity": "sha512-kPSSXE6De1XOR820C90RIo2ogvZG+c3KiHzqUoO/F34Y2shGzesfqv7o57xrxovZJH/MetF5UjroJ/R/3isoiw==", + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@xtuc/ieee754": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", + "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==", + "license": "BSD-3-Clause" + }, + "node_modules/@xtuc/long": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", + "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==", + "license": "Apache-2.0" + }, + "node_modules/accepts": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", + "license": "MIT", + "dependencies": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/negotiator": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/acorn": { + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", + "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-import-phases": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz", + "integrity": "sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ==", + "license": "MIT", + "engines": { + "node": ">=10.13.0" + }, + "peerDependencies": { + "acorn": "^8.14.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "license": "MIT", + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.3.5", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.5.tgz", + "integrity": "sha512-HEHNfbars9v4pgpW6SO1KSPkfoS0xVOM/9UzkJltjlsHZmJasxg8aXkuZa7SMf8vKGIBhpUsPluQSqhJFCqebw==", + "license": "MIT", + "dependencies": { + "acorn": "^8.11.0" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/address": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/address/-/address-1.2.2.tgz", + "integrity": "sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA==", + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/aggregate-error": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", + "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", + "license": "MIT", + "dependencies": { + "clean-stack": "^2.0.0", + "indent-string": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ajv": { + "version": "8.18.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", + "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-formats": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz", + "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==", + "license": "MIT", + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ajv-keywords": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-5.1.0.tgz", + "integrity": "sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3" + }, + "peerDependencies": { + "ajv": "^8.8.2" + } + }, + "node_modules/algoliasearch": { + "version": "5.50.0", + "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.50.0.tgz", + "integrity": "sha512-yE5I83Q2s8euVou8Y3feXK08wyZInJWLYXgWO6Xti9jBUEZAGUahyeQ7wSZWkifLWVnQVKEz5RAmBlXG5nqxog==", + "license": "MIT", + "dependencies": { + "@algolia/abtesting": "1.16.0", + "@algolia/client-abtesting": "5.50.0", + "@algolia/client-analytics": "5.50.0", + "@algolia/client-common": "5.50.0", + "@algolia/client-insights": "5.50.0", + "@algolia/client-personalization": "5.50.0", + "@algolia/client-query-suggestions": "5.50.0", + "@algolia/client-search": "5.50.0", + "@algolia/ingestion": "1.50.0", + "@algolia/monitoring": "1.50.0", + "@algolia/recommend": "5.50.0", + "@algolia/requester-browser-xhr": "5.50.0", + "@algolia/requester-fetch": "5.50.0", + "@algolia/requester-node-http": "5.50.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/algoliasearch-helper": { + "version": "3.28.1", + "resolved": "https://registry.npmjs.org/algoliasearch-helper/-/algoliasearch-helper-3.28.1.tgz", + "integrity": "sha512-6iXpbkkrAI5HFpCWXlNmIDSBuoN/U1XnEvb2yJAoWfqrZ+DrybI7MQ5P5mthFaprmocq+zbi6HxnR28xnZAYBw==", + "license": "MIT", + "dependencies": { + "@algolia/events": "^4.0.1" + }, + "peerDependencies": { + "algoliasearch": ">= 3.1 < 6" + } + }, + "node_modules/ansi-align": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", + "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", + "license": "ISC", + "dependencies": { + "string-width": "^4.1.0" + } + }, + "node_modules/ansi-align/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/ansi-align/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-escapes": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", + "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "license": "MIT", + "dependencies": { + "type-fest": "^0.21.3" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-escapes/node_modules/type-fest": { + "version": "0.21.3", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", + "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-html-community": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/ansi-html-community/-/ansi-html-community-0.0.8.tgz", + "integrity": "sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw==", + "engines": [ + "node >= 0.8.0" + ], + "license": "Apache-2.0", + "bin": { + "ansi-html": "bin/ansi-html" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "license": "ISC", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/arg": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", + "integrity": "sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==", + "license": "MIT" + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "node_modules/array-flatten": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", + "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "license": "MIT" + }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/asn1js": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/asn1js/-/asn1js-3.0.7.tgz", + "integrity": "sha512-uLvq6KJu04qoQM6gvBfKFjlh6Gl0vOKQuR5cJMDHQkmwfMOQeN3F3SHCv9SNYSL+CRoHvOGFfllDlVz03GQjvQ==", + "license": "BSD-3-Clause", + "dependencies": { + "pvtsutils": "^1.3.6", + "pvutils": "^1.1.3", + "tslib": "^2.8.1" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/astring": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/astring/-/astring-1.9.0.tgz", + "integrity": "sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg==", + "license": "MIT", + "bin": { + "astring": "bin/astring" + } + }, + "node_modules/autoprefixer": { + "version": "10.4.27", + "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.27.tgz", + "integrity": "sha512-NP9APE+tO+LuJGn7/9+cohklunJsXWiaWEfV3si4Gi/XHDwVNgkwr1J3RQYFIvPy76GmJ9/bW8vyoU1LcxwKHA==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/autoprefixer" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "browserslist": "^4.28.1", + "caniuse-lite": "^1.0.30001774", + "fraction.js": "^5.3.4", + "picocolors": "^1.1.1", + "postcss-value-parser": "^4.2.0" + }, + "bin": { + "autoprefixer": "bin/autoprefixer" + }, + "engines": { + "node": "^10 || ^12 || >=14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/babel-loader": { + "version": "9.2.1", + "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-9.2.1.tgz", + "integrity": "sha512-fqe8naHt46e0yIdkjUZYqddSXfej3AHajX+CSO5X7oy0EmPc6o5Xh+RClNoHjnieWz9AW4kZxW9yyFMhVB1QLA==", + "license": "MIT", + "dependencies": { + "find-cache-dir": "^4.0.0", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0", + "webpack": ">=5" + } + }, + "node_modules/babel-plugin-dynamic-import-node": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/babel-plugin-dynamic-import-node/-/babel-plugin-dynamic-import-node-2.3.3.tgz", + "integrity": "sha512-jZVI+s9Zg3IqA/kdi0i6UDCybUI3aSBLnglhYbSSjKlV7yF1F/5LWv8MakQmvYpnbJDS6fcBL2KzHSxNCMtWSQ==", + "license": "MIT", + "dependencies": { + "object.assign": "^4.1.0" + } + }, + "node_modules/babel-plugin-polyfill-corejs2": { + "version": "0.4.17", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.17.tgz", + "integrity": "sha512-aTyf30K/rqAsNwN76zYrdtx8obu0E4KoUME29B1xj+B3WxgvWkp943vYQ+z8Mv3lw9xHXMHpvSPOBxzAkIa94w==", + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.28.6", + "@babel/helper-define-polyfill-provider": "^0.6.8", + "semver": "^6.3.1" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-polyfill-corejs2/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz", + "integrity": "sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A==", + "license": "MIT", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.5", + "core-js-compat": "^3.43.0" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-polyfill-regenerator": { + "version": "0.6.8", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.8.tgz", + "integrity": "sha512-M762rNHfSF1EV3SLtnCJXFoQbbIIz0OyRwnCmV0KPC7qosSfCO0QLTSuJX3ayAebubhE6oYBAYPrBA5ljowaZg==", + "license": "MIT", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.8" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/bail": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/bail/-/bail-2.0.2.tgz", + "integrity": "sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" + }, + "node_modules/baseline-browser-mapping": { + "version": "2.10.11", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.11.tgz", + "integrity": "sha512-DAKrHphkJyiGuau/cFieRYhcTFeK/lBuD++C7cZ6KZHbMhBrisoi+EvhQ5RZrIfV5qwsW8kgQ07JIC+MDJRAhg==", + "license": "Apache-2.0", + "bin": { + "baseline-browser-mapping": "dist/cli.cjs" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/batch": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/batch/-/batch-0.6.1.tgz", + "integrity": "sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw==", + "license": "MIT" + }, + "node_modules/big.js": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", + "integrity": "sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==", + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/binary-extensions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", + "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/body-parser": { + "version": "1.20.4", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.4.tgz", + "integrity": "sha512-ZTgYYLMOXY9qKU/57FAo8F+HA2dGX7bqGc71txDRC1rS4frdFI5R7NhluHxH6M0YItAP0sHB4uqAOcYKxO6uGA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "content-type": "~1.0.5", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "~1.2.0", + "http-errors": "~2.0.1", + "iconv-lite": "~0.4.24", + "on-finished": "~2.4.1", + "qs": "~6.14.0", + "raw-body": "~2.5.3", + "type-is": "~1.6.18", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/body-parser/node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/body-parser/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/body-parser/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/bonjour-service": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/bonjour-service/-/bonjour-service-1.3.0.tgz", + "integrity": "sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "multicast-dns": "^7.2.5" + } + }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==", + "license": "ISC" + }, + "node_modules/boxen": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-6.2.1.tgz", + "integrity": "sha512-H4PEsJXfFI/Pt8sjDWbHlQPx4zL/bvSQjcilJmaulGt5mLDorHOHpmdXAJcBcmru7PhYSp/cDMWRko4ZUMFkSw==", + "license": "MIT", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^6.2.0", + "chalk": "^4.1.2", + "cli-boxes": "^3.0.0", + "string-width": "^5.0.1", + "type-fest": "^2.5.0", + "widest-line": "^4.0.1", + "wrap-ansi": "^8.0.1" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/brace-expansion": { + "version": "1.1.12", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", + "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browserslist": { + "version": "4.28.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz", + "integrity": "sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "baseline-browser-mapping": "^2.9.0", + "caniuse-lite": "^1.0.30001759", + "electron-to-chromium": "^1.5.263", + "node-releases": "^2.0.27", + "update-browserslist-db": "^1.2.0" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "license": "MIT" + }, + "node_modules/bundle-name": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/bundle-name/-/bundle-name-4.1.0.tgz", + "integrity": "sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q==", + "license": "MIT", + "dependencies": { + "run-applescript": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/bytes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", + "integrity": "sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/bytestreamjs": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/bytestreamjs/-/bytestreamjs-2.0.1.tgz", + "integrity": "sha512-U1Z/ob71V/bXfVABvNr/Kumf5VyeQRBEm6Txb0PQ6S7V5GpBM3w4Cbqz/xPDicR5tN0uvDifng8C+5qECeGwyQ==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/cacheable-lookup": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz", + "integrity": "sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w==", + "license": "MIT", + "engines": { + "node": ">=14.16" + } + }, + "node_modules/cacheable-request": { + "version": "10.2.14", + "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-10.2.14.tgz", + "integrity": "sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ==", + "license": "MIT", + "dependencies": { + "@types/http-cache-semantics": "^4.0.2", + "get-stream": "^6.0.1", + "http-cache-semantics": "^4.1.1", + "keyv": "^4.5.3", + "mimic-response": "^4.0.0", + "normalize-url": "^8.0.0", + "responselike": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + } + }, + "node_modules/call-bind": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", + "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.0", + "es-define-property": "^1.0.0", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/camel-case": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", + "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", + "license": "MIT", + "dependencies": { + "pascal-case": "^3.1.2", + "tslib": "^2.0.3" + } + }, + "node_modules/camelcase": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", + "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/caniuse-api": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", + "integrity": "sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.0.0", + "caniuse-lite": "^1.0.0", + "lodash.memoize": "^4.1.2", + "lodash.uniq": "^4.5.0" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001781", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001781.tgz", + "integrity": "sha512-RdwNCyMsNBftLjW6w01z8bKEvT6e/5tpPVEgtn22TiLGlstHOVecsX2KHFkD5e/vRnIE4EGzpuIODb3mtswtkw==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/ccount": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", + "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/char-regex": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", + "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/character-entities": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", + "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-html4": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", + "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-legacy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", + "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-reference-invalid": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz", + "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/cheerio": { + "version": "1.0.0-rc.12", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.12.tgz", + "integrity": "sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==", + "license": "MIT", + "dependencies": { + "cheerio-select": "^2.1.0", + "dom-serializer": "^2.0.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1", + "htmlparser2": "^8.0.1", + "parse5": "^7.0.0", + "parse5-htmlparser2-tree-adapter": "^7.0.0" + }, + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/cheeriojs/cheerio?sponsor=1" + } + }, + "node_modules/cheerio-select": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz", + "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-select": "^5.1.0", + "css-what": "^6.1.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/chokidar": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", + "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", + "license": "MIT", + "dependencies": { + "anymatch": "~3.1.2", + "braces": "~3.0.2", + "glob-parent": "~5.1.2", + "is-binary-path": "~2.1.0", + "is-glob": "~4.0.1", + "normalize-path": "~3.0.0", + "readdirp": "~3.6.0" + }, + "engines": { + "node": ">= 8.10.0" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/chrome-trace-event": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.4.tgz", + "integrity": "sha512-rNjApaLzuwaOTjCiT8lSDdGN1APCiqkChLMJxJPWLunPAt5fy8xgU9/jNOchV84wfIxrA0lRQB7oCT8jrn/wrQ==", + "license": "MIT", + "engines": { + "node": ">=6.0" + } + }, + "node_modules/ci-info": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", + "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/clean-css": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/clean-css/-/clean-css-5.3.3.tgz", + "integrity": "sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg==", + "license": "MIT", + "dependencies": { + "source-map": "~0.6.0" + }, + "engines": { + "node": ">= 10.0" + } + }, + "node_modules/clean-css/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/clean-stack": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", + "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/cli-boxes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/cli-table3": { + "version": "0.6.5", + "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.5.tgz", + "integrity": "sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ==", + "license": "MIT", + "dependencies": { + "string-width": "^4.2.0" + }, + "engines": { + "node": "10.* || >= 12.*" + }, + "optionalDependencies": { + "@colors/colors": "1.5.0" + } + }, + "node_modules/cli-table3/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/cli-table3/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/clone-deep": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", + "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", + "license": "MIT", + "dependencies": { + "is-plain-object": "^2.0.4", + "kind-of": "^6.0.2", + "shallow-clone": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/clsx": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", + "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/collapse-white-space": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-2.1.0.tgz", + "integrity": "sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" + }, + "node_modules/colord": { + "version": "2.9.3", + "resolved": "https://registry.npmjs.org/colord/-/colord-2.9.3.tgz", + "integrity": "sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==", + "license": "MIT" + }, + "node_modules/colorette": { + "version": "2.0.20", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", + "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==", + "license": "MIT" + }, + "node_modules/combine-promises": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/combine-promises/-/combine-promises-1.2.0.tgz", + "integrity": "sha512-VcQB1ziGD0NXrhKxiwyNbCDmRzs/OShMs2GqW2DlU2A/Sd0nQxE1oWDAE5O0ygSx5mgQOn9eIFh7yKPgFRVkPQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/comlink": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/comlink/-/comlink-4.4.2.tgz", + "integrity": "sha512-OxGdvBmJuNKSCMO4NTl1L47VRp6xn2wG4F/2hYzB6tiCb709otOxtEYCSvK80PtjODfXXZu8ds+Nw5kVCjqd2g==", + "license": "Apache-2.0" + }, + "node_modules/comma-separated-tokens": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", + "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/commander": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz", + "integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==", + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/common-path-prefix": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/common-path-prefix/-/common-path-prefix-3.0.0.tgz", + "integrity": "sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w==", + "license": "ISC" + }, + "node_modules/compressible": { + "version": "2.0.18", + "resolved": "https://registry.npmjs.org/compressible/-/compressible-2.0.18.tgz", + "integrity": "sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg==", + "license": "MIT", + "dependencies": { + "mime-db": ">= 1.43.0 < 2" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/compressible/node_modules/mime-db": { + "version": "1.54.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", + "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/compression": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/compression/-/compression-1.8.1.tgz", + "integrity": "sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w==", + "license": "MIT", + "dependencies": { + "bytes": "3.1.2", + "compressible": "~2.0.18", + "debug": "2.6.9", + "negotiator": "~0.6.4", + "on-headers": "~1.1.0", + "safe-buffer": "5.2.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/compression/node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/compression/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/compression/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "license": "MIT" + }, + "node_modules/config-chain": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", + "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", + "license": "MIT", + "dependencies": { + "ini": "^1.3.4", + "proto-list": "~1.2.1" + } + }, + "node_modules/config-chain/node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "license": "ISC" + }, + "node_modules/configstore": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", + "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", + "license": "BSD-2-Clause", + "dependencies": { + "dot-prop": "^6.0.1", + "graceful-fs": "^4.2.6", + "unique-string": "^3.0.0", + "write-file-atomic": "^3.0.3", + "xdg-basedir": "^5.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/yeoman/configstore?sponsor=1" + } + }, + "node_modules/connect-history-api-fallback": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/connect-history-api-fallback/-/connect-history-api-fallback-2.0.0.tgz", + "integrity": "sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA==", + "license": "MIT", + "engines": { + "node": ">=0.8" + } + }, + "node_modules/consola": { + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/consola/-/consola-3.4.2.tgz", + "integrity": "sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA==", + "license": "MIT", + "engines": { + "node": "^14.18.0 || >=16.10.0" + } + }, + "node_modules/content-disposition": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.2.tgz", + "integrity": "sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/content-type": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", + "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "license": "MIT" + }, + "node_modules/cookie": { + "version": "0.7.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", + "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.7.tgz", + "integrity": "sha512-NXdYc3dLr47pBkpUCHtKSwIOQXLVn8dZEuywboCOJY/osA0wFSLlSawr3KN8qXJEyX66FcONTH8EIlVuK0yyFA==", + "license": "MIT" + }, + "node_modules/copy-webpack-plugin": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz", + "integrity": "sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ==", + "license": "MIT", + "dependencies": { + "fast-glob": "^3.2.11", + "glob-parent": "^6.0.1", + "globby": "^13.1.1", + "normalize-path": "^3.0.0", + "schema-utils": "^4.0.0", + "serialize-javascript": "^6.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + } + }, + "node_modules/copy-webpack-plugin/node_modules/glob-parent": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", + "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.3" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/copy-webpack-plugin/node_modules/globby": { + "version": "13.2.2", + "resolved": "https://registry.npmjs.org/globby/-/globby-13.2.2.tgz", + "integrity": "sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==", + "license": "MIT", + "dependencies": { + "dir-glob": "^3.0.1", + "fast-glob": "^3.3.0", + "ignore": "^5.2.4", + "merge2": "^1.4.1", + "slash": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/copy-webpack-plugin/node_modules/slash": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", + "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/core-js": { + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.49.0.tgz", + "integrity": "sha512-es1U2+YTtzpwkxVLwAFdSpaIMyQaq0PBgm3YD1W3Qpsn1NAmO3KSgZfu+oGSWVu6NvLHoHCV/aYcsE5wiB7ALg==", + "hasInstallScript": true, + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-js-compat": { + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.49.0.tgz", + "integrity": "sha512-VQXt1jr9cBz03b331DFDCCP90b3fanciLkgiOoy8SBHy06gNf+vQ1A3WFLqG7I8TipYIKeYK9wxd0tUrvHcOZA==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.28.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-js-pure": { + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js-pure/-/core-js-pure-3.49.0.tgz", + "integrity": "sha512-XM4RFka59xATyJv/cS3O3Kml72hQXUeGRuuTmMYFxwzc9/7C8OYTaIR/Ji+Yt8DXzsFLNhat15cE/JP15HrCgw==", + "hasInstallScript": true, + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-util-is": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", + "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==", + "license": "MIT" + }, + "node_modules/cosmiconfig": { + "version": "8.3.6", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-8.3.6.tgz", + "integrity": "sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==", + "license": "MIT", + "dependencies": { + "import-fresh": "^3.3.0", + "js-yaml": "^4.1.0", + "parse-json": "^5.2.0", + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/d-fischer" + }, + "peerDependencies": { + "typescript": ">=4.9.5" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/cross-spawn": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/crypto-random-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", + "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", + "license": "MIT", + "dependencies": { + "type-fest": "^1.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/crypto-random-string/node_modules/type-fest": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", + "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/css-blank-pseudo": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/css-blank-pseudo/-/css-blank-pseudo-7.0.1.tgz", + "integrity": "sha512-jf+twWGDf6LDoXDUode+nc7ZlrqfaNphrBIBrcmeP3D8yw1uPaix1gCC8LUQUGQ6CycuK2opkbFFWFuq/a94ag==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/css-blank-pseudo/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/css-declaration-sorter": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/css-declaration-sorter/-/css-declaration-sorter-7.3.1.tgz", + "integrity": "sha512-gz6x+KkgNCjxq3Var03pRYLhyNfwhkKF1g/yoLgDNtFvVu0/fOLV9C8fFEZRjACp/XQLumjAYo7JVjzH3wLbxA==", + "license": "ISC", + "engines": { + "node": "^14 || ^16 || >=18" + }, + "peerDependencies": { + "postcss": "^8.0.9" + } + }, + "node_modules/css-has-pseudo": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/css-has-pseudo/-/css-has-pseudo-7.0.3.tgz", + "integrity": "sha512-oG+vKuGyqe/xvEMoxAQrhi7uY16deJR3i7wwhBerVrGQKSqUC5GiOVxTpM9F9B9hw0J+eKeOWLH7E9gZ1Dr5rA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/selector-specificity": "^5.0.0", + "postcss-selector-parser": "^7.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/css-has-pseudo/node_modules/@csstools/selector-specificity": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", + "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/css-has-pseudo/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/css-loader": { + "version": "6.11.0", + "resolved": "https://registry.npmjs.org/css-loader/-/css-loader-6.11.0.tgz", + "integrity": "sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g==", + "license": "MIT", + "dependencies": { + "icss-utils": "^5.1.0", + "postcss": "^8.4.33", + "postcss-modules-extract-imports": "^3.1.0", + "postcss-modules-local-by-default": "^4.0.5", + "postcss-modules-scope": "^3.2.0", + "postcss-modules-values": "^4.0.0", + "postcss-value-parser": "^4.2.0", + "semver": "^7.5.4" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "@rspack/core": "0.x || 1.x", + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "@rspack/core": { + "optional": true + }, + "webpack": { + "optional": true + } + } + }, + "node_modules/css-minimizer-webpack-plugin": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/css-minimizer-webpack-plugin/-/css-minimizer-webpack-plugin-5.0.1.tgz", + "integrity": "sha512-3caImjKFQkS+ws1TGcFn0V1HyDJFq1Euy589JlD6/3rV2kj+w7r5G9WDMgSHvpvXHNZ2calVypZWuEDQd9wfLg==", + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.18", + "cssnano": "^6.0.1", + "jest-worker": "^29.4.3", + "postcss": "^8.4.24", + "schema-utils": "^4.0.1", + "serialize-javascript": "^6.0.1" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "@parcel/css": { + "optional": true + }, + "@swc/css": { + "optional": true + }, + "clean-css": { + "optional": true + }, + "csso": { + "optional": true + }, + "esbuild": { + "optional": true + }, + "lightningcss": { + "optional": true + } + } + }, + "node_modules/css-prefers-color-scheme": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/css-prefers-color-scheme/-/css-prefers-color-scheme-10.0.0.tgz", + "integrity": "sha512-VCtXZAWivRglTZditUfB4StnsWr6YVZ2PRtuxQLKTNRdtAf8tpzaVPE9zXIF3VaSc7O70iK/j1+NXxyQCqdPjQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/css-select": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.2.2.tgz", + "integrity": "sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.1.0", + "domhandler": "^5.0.2", + "domutils": "^3.0.1", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/css-tree": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.3.1.tgz", + "integrity": "sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw==", + "license": "MIT", + "dependencies": { + "mdn-data": "2.0.30", + "source-map-js": "^1.0.1" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0" + } + }, + "node_modules/css-what": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.2.2.tgz", + "integrity": "sha512-u/O3vwbptzhMs3L1fQE82ZSLHQQfto5gyZzwteVIEyeaY5Fc7R4dapF/BvRoSYFeqfBk4m0V1Vafq5Pjv25wvA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/cssdb": { + "version": "8.8.0", + "resolved": "https://registry.npmjs.org/cssdb/-/cssdb-8.8.0.tgz", + "integrity": "sha512-QbLeyz2Bgso1iRlh7IpWk6OKa3lLNGXsujVjDMPl9rOZpxKeiG69icLpbLCFxeURwmcdIfZqQyhlooKJYM4f8Q==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + }, + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + } + ], + "license": "MIT-0" + }, + "node_modules/cssesc": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", + "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==", + "license": "MIT", + "bin": { + "cssesc": "bin/cssesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/cssnano": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano/-/cssnano-6.1.2.tgz", + "integrity": "sha512-rYk5UeX7VAM/u0lNqewCdasdtPK81CgX8wJFLEIXHbV2oldWRgJAsZrdhRXkV1NJzA2g850KiFm9mMU2HxNxMA==", + "license": "MIT", + "dependencies": { + "cssnano-preset-default": "^6.1.2", + "lilconfig": "^3.1.1" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/cssnano" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-preset-advanced": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano-preset-advanced/-/cssnano-preset-advanced-6.1.2.tgz", + "integrity": "sha512-Nhao7eD8ph2DoHolEzQs5CfRpiEP0xa1HBdnFZ82kvqdmbwVBUr2r1QuQ4t1pi+D1ZpqpcO4T+wy/7RxzJ/WPQ==", + "license": "MIT", + "dependencies": { + "autoprefixer": "^10.4.19", + "browserslist": "^4.23.0", + "cssnano-preset-default": "^6.1.2", + "postcss-discard-unused": "^6.0.5", + "postcss-merge-idents": "^6.0.3", + "postcss-reduce-idents": "^6.0.3", + "postcss-zindex": "^6.0.2" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-preset-default": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano-preset-default/-/cssnano-preset-default-6.1.2.tgz", + "integrity": "sha512-1C0C+eNaeN8OcHQa193aRgYexyJtU8XwbdieEjClw+J9d94E41LwT6ivKH0WT+fYwYWB0Zp3I3IZ7tI/BbUbrg==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "css-declaration-sorter": "^7.2.0", + "cssnano-utils": "^4.0.2", + "postcss-calc": "^9.0.1", + "postcss-colormin": "^6.1.0", + "postcss-convert-values": "^6.1.0", + "postcss-discard-comments": "^6.0.2", + "postcss-discard-duplicates": "^6.0.3", + "postcss-discard-empty": "^6.0.3", + "postcss-discard-overridden": "^6.0.2", + "postcss-merge-longhand": "^6.0.5", + "postcss-merge-rules": "^6.1.1", + "postcss-minify-font-values": "^6.1.0", + "postcss-minify-gradients": "^6.0.3", + "postcss-minify-params": "^6.1.0", + "postcss-minify-selectors": "^6.0.4", + "postcss-normalize-charset": "^6.0.2", + "postcss-normalize-display-values": "^6.0.2", + "postcss-normalize-positions": "^6.0.2", + "postcss-normalize-repeat-style": "^6.0.2", + "postcss-normalize-string": "^6.0.2", + "postcss-normalize-timing-functions": "^6.0.2", + "postcss-normalize-unicode": "^6.1.0", + "postcss-normalize-url": "^6.0.2", + "postcss-normalize-whitespace": "^6.0.2", + "postcss-ordered-values": "^6.0.2", + "postcss-reduce-initial": "^6.1.0", + "postcss-reduce-transforms": "^6.0.2", + "postcss-svgo": "^6.0.3", + "postcss-unique-selectors": "^6.0.4" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-utils": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/cssnano-utils/-/cssnano-utils-4.0.2.tgz", + "integrity": "sha512-ZR1jHg+wZ8o4c3zqf1SIUSTIvm/9mU343FMR6Obe/unskbvpGhZOo1J6d/r8D1pzkRQYuwbcH3hToOuoA2G7oQ==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/csso": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/csso/-/csso-5.0.5.tgz", + "integrity": "sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ==", + "license": "MIT", + "dependencies": { + "css-tree": "~2.2.0" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", + "npm": ">=7.0.0" + } + }, + "node_modules/csso/node_modules/css-tree": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.2.1.tgz", + "integrity": "sha512-OA0mILzGc1kCOCSJerOeqDxDQ4HOh+G8NbOJFOTgOCzpw7fCBubk0fEyxp8AgOL/jvLgYA/uV0cMbe43ElF1JA==", + "license": "MIT", + "dependencies": { + "mdn-data": "2.0.28", + "source-map-js": "^1.0.1" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", + "npm": ">=7.0.0" + } + }, + "node_modules/csso/node_modules/mdn-data": { + "version": "2.0.28", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.28.tgz", + "integrity": "sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g==", + "license": "CC0-1.0" + }, + "node_modules/csstype": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", + "license": "MIT" + }, + "node_modules/debounce": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/debounce/-/debounce-1.2.1.tgz", + "integrity": "sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug==", + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/decode-named-character-reference": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.3.0.tgz", + "integrity": "sha512-GtpQYB283KrPp6nRw50q3U9/VfOutZOe103qlN7BPP6Ad27xYnOIWv4lPzo8HCAL+mMZofJ9KEy30fq6MfaK6Q==", + "license": "MIT", + "dependencies": { + "character-entities": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/decompress-response": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", + "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", + "license": "MIT", + "dependencies": { + "mimic-response": "^3.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/decompress-response/node_modules/mimic-response": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", + "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "license": "MIT", + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/deepmerge": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/default-browser": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/default-browser/-/default-browser-5.5.0.tgz", + "integrity": "sha512-H9LMLr5zwIbSxrmvikGuI/5KGhZ8E2zH3stkMgM5LpOWDutGM2JZaj460Udnf1a+946zc7YBgrqEWwbk7zHvGw==", + "license": "MIT", + "dependencies": { + "bundle-name": "^4.1.0", + "default-browser-id": "^5.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/default-browser-id": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/default-browser-id/-/default-browser-id-5.0.1.tgz", + "integrity": "sha512-x1VCxdX4t+8wVfd1so/9w+vQ4vx7lKd2Qp5tDRutErwmR85OgmfX7RlLRMWafRMY7hbEiXIbudNrjOAPa/hL8Q==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/defer-to-connect": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", + "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-lazy-prop": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", + "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/depd": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", + "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/destroy": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", + "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "license": "MIT", + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/detect-node": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/detect-node/-/detect-node-2.1.0.tgz", + "integrity": "sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g==", + "license": "MIT" + }, + "node_modules/detect-port": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/detect-port/-/detect-port-1.6.1.tgz", + "integrity": "sha512-CmnVc+Hek2egPx1PeTFVta2W78xy2K/9Rkf6cC4T59S50tVnzKj+tnx5mmx5lwvCkujZ4uRrpRSuV+IVs3f90Q==", + "license": "MIT", + "dependencies": { + "address": "^1.0.1", + "debug": "4" + }, + "bin": { + "detect": "bin/detect-port.js", + "detect-port": "bin/detect-port.js" + }, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "license": "MIT", + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "license": "MIT", + "dependencies": { + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/dns-packet": { + "version": "5.6.1", + "resolved": "https://registry.npmjs.org/dns-packet/-/dns-packet-5.6.1.tgz", + "integrity": "sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw==", + "license": "MIT", + "dependencies": { + "@leichtgewicht/ip-codec": "^2.0.1" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/docusaurus-plugin-typedoc": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-typedoc/-/docusaurus-plugin-typedoc-1.4.2.tgz", + "integrity": "sha512-1qerRejLSYxEWdyVPLDMMeKFPLA/37yZAsdwJy9ThHFQR78+v3b5spSbk67VHGLr2mAn4FVHu0aGJ6p7iWotSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "typedoc-docusaurus-theme": "^1.4.0" + }, + "peerDependencies": { + "typedoc-plugin-markdown": ">=4.8.0" + } + }, + "node_modules/dom-converter": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", + "integrity": "sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA==", + "license": "MIT", + "dependencies": { + "utila": "~0.4" + } + }, + "node_modules/dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/domelementtype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", + "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "BSD-2-Clause" + }, + "node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/domutils": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz", + "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==", + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/dot-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", + "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/dot-prop": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", + "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", + "license": "MIT", + "dependencies": { + "is-obj": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/dot-prop/node_modules/is-obj": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", + "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/duplexer": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", + "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", + "license": "MIT" + }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "license": "MIT" + }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", + "license": "MIT" + }, + "node_modules/electron-to-chromium": { + "version": "1.5.325", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.325.tgz", + "integrity": "sha512-PwfIw7WQSt3xX7yOf5OE/unLzsK9CaN2f/FvV3WjPR1Knoc1T9vePRVV4W1EM301JzzysK51K7FNKcusCr0zYA==", + "license": "ISC" + }, + "node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "license": "MIT" + }, + "node_modules/emojilib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/emojilib/-/emojilib-2.4.0.tgz", + "integrity": "sha512-5U0rVMU5Y2n2+ykNLQqMoqklN9ICBT/KsvC1Gz6vqHbz2AXXGkG+Pm5rMWk/8Vjrr/mY9985Hi8DYzn1F09Nyw==", + "license": "MIT" + }, + "node_modules/emojis-list": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/emojis-list/-/emojis-list-3.0.0.tgz", + "integrity": "sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/emoticon": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/emoticon/-/emoticon-4.1.0.tgz", + "integrity": "sha512-VWZfnxqwNcc51hIy/sbOdEem6D+cVtpPzEEtVAFdaas30+1dgkyaOQ4sQ6Bp0tOMqWO1v+HQfYaoodOkdhK6SQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/encodeurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz", + "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/encoding-sniffer": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/encoding-sniffer/-/encoding-sniffer-0.2.1.tgz", + "integrity": "sha512-5gvq20T6vfpekVtqrYQsSCFZ1wEg5+wW0/QaZMWkFr6BqD3NfKs0rLCx4rrVlSWJeZb5NBJgVLswK/w2MWU+Gw==", + "license": "MIT", + "dependencies": { + "iconv-lite": "^0.6.3", + "whatwg-encoding": "^3.1.1" + }, + "funding": { + "url": "https://github.com/fb55/encoding-sniffer?sponsor=1" + } + }, + "node_modules/encoding-sniffer/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/enhanced-resolve": { + "version": "5.20.1", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.20.1.tgz", + "integrity": "sha512-Qohcme7V1inbAfvjItgw0EaxVX5q2rdVEZHRBrEQdRZTssLDGsL8Lwrznl8oQ/6kuTJONLaDcGjkNP247XEhcA==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.4", + "tapable": "^2.3.0" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/error-ex": { + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.4.tgz", + "integrity": "sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ==", + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-module-lexer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.0.0.tgz", + "integrity": "sha512-5POEcUuZybH7IdmGsD8wlf0AI55wMecM9rVBTI/qEAy2c1kTOm3DjFYjrBdI2K3BaJjJYfYFeRtM0t9ssnRuxw==", + "license": "MIT" + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/esast-util-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz", + "integrity": "sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/esast-util-from-js": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/esast-util-from-js/-/esast-util-from-js-2.0.1.tgz", + "integrity": "sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "acorn": "^8.0.0", + "esast-util-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-goat": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", + "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", + "license": "MIT" + }, + "node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "license": "BSD-2-Clause", + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "license": "BSD-2-Clause", + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esrecurse/node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estree-util-attach-comments": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz", + "integrity": "sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-build-jsx": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/estree-util-build-jsx/-/estree-util-build-jsx-3.0.1.tgz", + "integrity": "sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-walker": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-is-identifier-name": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz", + "integrity": "sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-scope": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/estree-util-scope/-/estree-util-scope-1.0.0.tgz", + "integrity": "sha512-2CAASclonf+JFWBNJPndcOpA8EMJwa0Q8LUFJEKqXLW6+qBvbFZuF5gItbQOs/umBUkjviCSDCbBwU2cXbmrhQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-to-js": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-to-js/-/estree-util-to-js-2.0.0.tgz", + "integrity": "sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "astring": "^1.8.0", + "source-map": "^0.7.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-value-to-estree": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.5.0.tgz", + "integrity": "sha512-aMV56R27Gv3QmfmF1MY12GWkGzzeAezAX+UplqHVASfjc9wNzI/X6hC0S9oxq61WT4aQesLGslWP9tKk6ghRZQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/remcohaszing" + } + }, + "node_modules/estree-util-visit": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-2.0.0.tgz", + "integrity": "sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eta": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/eta/-/eta-2.2.0.tgz", + "integrity": "sha512-UVQ72Rqjy/ZKQalzV5dCCJP80GrmPrMxh6NlNf+erV6ObL0ZFkhCstWRawS85z3smdr3d2wXPsZEY7rDPfGd2g==", + "license": "MIT", + "engines": { + "node": ">=6.0.0" + }, + "funding": { + "url": "https://github.com/eta-dev/eta?sponsor=1" + } + }, + "node_modules/etag": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", + "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/eval": { + "version": "0.1.8", + "resolved": "https://registry.npmjs.org/eval/-/eval-0.1.8.tgz", + "integrity": "sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw==", + "dependencies": { + "@types/node": "*", + "require-like": ">= 0.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/eventemitter3": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", + "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", + "license": "MIT" + }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "license": "MIT", + "engines": { + "node": ">=0.8.x" + } + }, + "node_modules/execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "license": "MIT", + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/express": { + "version": "4.22.1", + "resolved": "https://registry.npmjs.org/express/-/express-4.22.1.tgz", + "integrity": "sha512-F2X8g9P1X7uCPZMA3MVf9wcTqlyNp7IhH5qPCI0izhaOIYXaW9L535tGA3qmjRzpH+bZczqq7hVKxTR4NWnu+g==", + "license": "MIT", + "dependencies": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "~1.20.3", + "content-disposition": "~0.5.4", + "content-type": "~1.0.4", + "cookie": "~0.7.1", + "cookie-signature": "~1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "~1.3.1", + "fresh": "~0.5.2", + "http-errors": "~2.0.0", + "merge-descriptors": "1.0.3", + "methods": "~1.1.2", + "on-finished": "~2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "~0.1.12", + "proxy-addr": "~2.0.7", + "qs": "~6.14.0", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "~0.19.0", + "serve-static": "~1.16.2", + "setprototypeof": "1.2.0", + "statuses": "~2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/express/node_modules/content-disposition": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", + "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", + "license": "MIT", + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/express/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/express/node_modules/path-to-regexp": { + "version": "0.1.13", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.13.tgz", + "integrity": "sha512-A/AGNMFN3c8bOlvV9RreMdrv7jsmF9XIfDeCd87+I8RNg6s78BhJxMu69NEMHBSJFxKidViTEdruRwEk/WIKqA==", + "license": "MIT" + }, + "node_modules/express/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "license": "MIT" + }, + "node_modules/extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", + "license": "MIT", + "dependencies": { + "is-extendable": "^0.1.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "license": "MIT" + }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "license": "MIT" + }, + "node_modules/fast-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", + "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/fastq": { + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fault": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/fault/-/fault-2.0.1.tgz", + "integrity": "sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ==", + "license": "MIT", + "dependencies": { + "format": "^0.2.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/faye-websocket": { + "version": "0.11.4", + "resolved": "https://registry.npmjs.org/faye-websocket/-/faye-websocket-0.11.4.tgz", + "integrity": "sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g==", + "license": "Apache-2.0", + "dependencies": { + "websocket-driver": ">=0.5.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/feed": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/feed/-/feed-4.2.2.tgz", + "integrity": "sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ==", + "license": "MIT", + "dependencies": { + "xml-js": "^1.6.11" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/figures": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", + "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", + "license": "MIT", + "dependencies": { + "escape-string-regexp": "^1.0.5" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/figures/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "license": "MIT", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/file-loader": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/file-loader/-/file-loader-6.2.0.tgz", + "integrity": "sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw==", + "license": "MIT", + "dependencies": { + "loader-utils": "^2.0.0", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/file-loader/node_modules/ajv": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", + "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/file-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "license": "MIT", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/file-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "license": "MIT" + }, + "node_modules/file-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/finalhandler": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.2.tgz", + "integrity": "sha512-aA4RyPcd3badbdABGDuTXCMTtOneUCAYH/gxoYRTZlIJdF0YPWuGqiAsIrhNnnqdXGswYk6dGujem4w80UJFhg==", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "on-finished": "~2.4.1", + "parseurl": "~1.3.3", + "statuses": "~2.0.2", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/finalhandler/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/finalhandler/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/find-cache-dir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-4.0.0.tgz", + "integrity": "sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg==", + "license": "MIT", + "dependencies": { + "common-path-prefix": "^3.0.0", + "pkg-dir": "^7.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/find-up": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-6.3.0.tgz", + "integrity": "sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw==", + "license": "MIT", + "dependencies": { + "locate-path": "^7.1.0", + "path-exists": "^5.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/flat": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/flat/-/flat-5.0.2.tgz", + "integrity": "sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==", + "license": "BSD-3-Clause", + "bin": { + "flat": "cli.js" + } + }, + "node_modules/follow-redirects": { + "version": "1.15.11", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.11.tgz", + "integrity": "sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "license": "MIT", + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/form-data-encoder": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-2.1.4.tgz", + "integrity": "sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw==", + "license": "MIT", + "engines": { + "node": ">= 14.17" + } + }, + "node_modules/format": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz", + "integrity": "sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww==", + "engines": { + "node": ">=0.4.x" + } + }, + "node_modules/forwarded": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", + "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fraction.js": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/fraction.js/-/fraction.js-5.3.4.tgz", + "integrity": "sha512-1X1NTtiJphryn/uLQz3whtY6jK3fTqoE3ohKs0tT+Ujr1W59oopxmoEh7Lu5p6vBaPbgoM0bzveAW4Qi5RyWDQ==", + "license": "MIT", + "engines": { + "node": "*" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/rawify" + } + }, + "node_modules/fresh": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fs-extra": { + "version": "11.3.4", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.4.tgz", + "integrity": "sha512-CTXd6rk/M3/ULNQj8FBqBWHYBVYybQ3VPBw0xGKFe3tuH7ytT6ACnvzpIQ3UZtB8yvUKC2cXn1a+x+5EVQLovA==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=14.14" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-own-enumerable-property-symbols": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz", + "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==", + "license": "ISC" + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/get-stream": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", + "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/github-slugger": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.5.0.tgz", + "integrity": "sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw==", + "license": "ISC" + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/glob-to-regex.js": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/glob-to-regex.js/-/glob-to-regex.js-1.2.0.tgz", + "integrity": "sha512-QMwlOQKU/IzqMUOAZWubUOT8Qft+Y0KQWnX9nK3ch0CJg0tTp4TvGZsTfudYKv2NzoQSyPcnA6TYeIQ3jGichQ==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/glob-to-regexp": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", + "integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==", + "license": "BSD-2-Clause" + }, + "node_modules/global-dirs": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.1.tgz", + "integrity": "sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA==", + "license": "MIT", + "dependencies": { + "ini": "2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "license": "MIT", + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/got": { + "version": "12.6.1", + "resolved": "https://registry.npmjs.org/got/-/got-12.6.1.tgz", + "integrity": "sha512-mThBblvlAF1d4O5oqyvN+ZxLAYwIJK7bpMxgYqPD9okW0C3qm5FFn7k811QrcuEBwaogR3ngOFoCfs6mRv7teQ==", + "license": "MIT", + "dependencies": { + "@sindresorhus/is": "^5.2.0", + "@szmarczak/http-timer": "^5.0.1", + "cacheable-lookup": "^7.0.0", + "cacheable-request": "^10.2.8", + "decompress-response": "^6.0.0", + "form-data-encoder": "^2.1.2", + "get-stream": "^6.0.1", + "http2-wrapper": "^2.1.10", + "lowercase-keys": "^3.0.0", + "p-cancelable": "^3.0.0", + "responselike": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sindresorhus/got?sponsor=1" + } + }, + "node_modules/got/node_modules/@sindresorhus/is": { + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-5.6.0.tgz", + "integrity": "sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sindresorhus/is?sponsor=1" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "license": "ISC" + }, + "node_modules/gray-matter": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/gray-matter/-/gray-matter-4.0.3.tgz", + "integrity": "sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q==", + "license": "MIT", + "dependencies": { + "js-yaml": "^3.13.1", + "kind-of": "^6.0.2", + "section-matter": "^1.0.0", + "strip-bom-string": "^1.0.0" + }, + "engines": { + "node": ">=6.0" + } + }, + "node_modules/gray-matter/node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/gray-matter/node_modules/js-yaml": { + "version": "3.14.2", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz", + "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==", + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/gzip-size": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/gzip-size/-/gzip-size-6.0.0.tgz", + "integrity": "sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==", + "license": "MIT", + "dependencies": { + "duplexer": "^0.1.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/handle-thing": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/handle-thing/-/handle-thing-2.0.1.tgz", + "integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==", + "license": "MIT" + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-yarn": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", + "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/hast-util-from-parse5": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/hast-util-from-parse5/-/hast-util-from-parse5-8.0.3.tgz", + "integrity": "sha512-3kxEVkEKt0zvcZ3hCRYI8rqrgwtlIOFMWkbclACvjlDw8Li9S2hk/d51OI0nr/gIpdMHNepwgOKqZ/sy0Clpyg==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "hastscript": "^9.0.0", + "property-information": "^7.0.0", + "vfile": "^6.0.0", + "vfile-location": "^5.0.0", + "web-namespaces": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-parse-selector": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz", + "integrity": "sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-raw": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/hast-util-raw/-/hast-util-raw-9.1.0.tgz", + "integrity": "sha512-Y8/SBAHkZGoNkpzqqfCldijcuUKh7/su31kEBp67cFY09Wy0mTRgtsLYsiIxMJxlu0f6AA5SUTbDR8K0rxnbUw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "@ungap/structured-clone": "^1.0.0", + "hast-util-from-parse5": "^8.0.0", + "hast-util-to-parse5": "^8.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "parse5": "^7.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-estree": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz", + "integrity": "sha512-48+B/rJWAp0jamNbAAf9M7Uf//UVqAoMmgXhBdxTDJLGKY+LRnZ99qcG+Qjl5HfMpYNzS5v4EAwVEF34LeAj7w==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-attach-comments": "^3.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-jsx-runtime": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz", + "integrity": "sha512-zl6s8LwNyo1P9uw+XJGvZtdFF1GdAkOg8ujOw+4Pyb76874fLps4ueHXDhXWdk6YHQ6OgUtinliG7RsYvCbbBg==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-parse5": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/hast-util-to-parse5/-/hast-util-to-parse5-8.0.1.tgz", + "integrity": "sha512-MlWT6Pjt4CG9lFCjiz4BH7l9wmrMkfkJYCxFwKQic8+RTZgWPuWxwAfjJElsXkex7DJjfSJsQIt931ilUgmwdA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-whitespace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", + "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hastscript": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-9.0.1.tgz", + "integrity": "sha512-g7df9rMFX/SPi34tyGCyUBREQoKkapwdY/T04Qn9TDWfHhAYt4/I0gMVirzK5wEzeUqIjEB+LXC/ypb7Aqno5w==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-parse-selector": "^4.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/he": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", + "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", + "license": "MIT", + "bin": { + "he": "bin/he" + } + }, + "node_modules/history": { + "version": "4.10.1", + "resolved": "https://registry.npmjs.org/history/-/history-4.10.1.tgz", + "integrity": "sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.1.2", + "loose-envify": "^1.2.0", + "resolve-pathname": "^3.0.0", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0", + "value-equal": "^1.0.1" + } + }, + "node_modules/hoist-non-react-statics": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz", + "integrity": "sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==", + "license": "BSD-3-Clause", + "dependencies": { + "react-is": "^16.7.0" + } + }, + "node_modules/hpack.js": { + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/hpack.js/-/hpack.js-2.1.6.tgz", + "integrity": "sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ==", + "license": "MIT", + "dependencies": { + "inherits": "^2.0.1", + "obuf": "^1.0.0", + "readable-stream": "^2.0.1", + "wbuf": "^1.1.0" + } + }, + "node_modules/hpack.js/node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "license": "MIT" + }, + "node_modules/hpack.js/node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "license": "MIT", + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "node_modules/hpack.js/node_modules/safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "license": "MIT" + }, + "node_modules/hpack.js/node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "license": "MIT" + }, + "node_modules/html-minifier-terser": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-7.2.0.tgz", + "integrity": "sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA==", + "license": "MIT", + "dependencies": { + "camel-case": "^4.1.2", + "clean-css": "~5.3.2", + "commander": "^10.0.0", + "entities": "^4.4.0", + "param-case": "^3.0.4", + "relateurl": "^0.2.7", + "terser": "^5.15.1" + }, + "bin": { + "html-minifier-terser": "cli.js" + }, + "engines": { + "node": "^14.13.1 || >=16.0.0" + } + }, + "node_modules/html-minifier-terser/node_modules/commander": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz", + "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", + "license": "MIT", + "engines": { + "node": ">=14" + } + }, + "node_modules/html-tags": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/html-tags/-/html-tags-3.3.1.tgz", + "integrity": "sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/html-void-elements": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", + "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/html-webpack-plugin": { + "version": "5.6.6", + "resolved": "https://registry.npmjs.org/html-webpack-plugin/-/html-webpack-plugin-5.6.6.tgz", + "integrity": "sha512-bLjW01UTrvoWTJQL5LsMRo1SypHW80FTm12OJRSnr3v6YHNhfe+1r0MYUZJMACxnCHURVnBWRwAsWs2yPU9Ezw==", + "license": "MIT", + "dependencies": { + "@types/html-minifier-terser": "^6.0.0", + "html-minifier-terser": "^6.0.2", + "lodash": "^4.17.21", + "pretty-error": "^4.0.0", + "tapable": "^2.0.0" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/html-webpack-plugin" + }, + "peerDependencies": { + "@rspack/core": "0.x || 1.x", + "webpack": "^5.20.0" + }, + "peerDependenciesMeta": { + "@rspack/core": { + "optional": true + }, + "webpack": { + "optional": true + } + } + }, + "node_modules/html-webpack-plugin/node_modules/commander": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", + "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==", + "license": "MIT", + "engines": { + "node": ">= 12" + } + }, + "node_modules/html-webpack-plugin/node_modules/html-minifier-terser": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", + "integrity": "sha512-YXxSlJBZTP7RS3tWnQw74ooKa6L9b9i9QYXY21eUEvhZ3u9XLfv6OnFsQq6RxkhHygsaUMvYsZRV5rU/OVNZxw==", + "license": "MIT", + "dependencies": { + "camel-case": "^4.1.2", + "clean-css": "^5.2.2", + "commander": "^8.3.0", + "he": "^1.2.0", + "param-case": "^3.0.4", + "relateurl": "^0.2.7", + "terser": "^5.10.0" + }, + "bin": { + "html-minifier-terser": "cli.js" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/htmlparser2": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-8.0.2.tgz", + "integrity": "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1", + "entities": "^4.4.0" + } + }, + "node_modules/http-cache-semantics": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", + "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==", + "license": "BSD-2-Clause" + }, + "node_modules/http-deceiver": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/http-deceiver/-/http-deceiver-1.2.7.tgz", + "integrity": "sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw==", + "license": "MIT" + }, + "node_modules/http-errors": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", + "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", + "license": "MIT", + "dependencies": { + "depd": "~2.0.0", + "inherits": "~2.0.4", + "setprototypeof": "~1.2.0", + "statuses": "~2.0.2", + "toidentifier": "~1.0.1" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/http-parser-js": { + "version": "0.5.10", + "resolved": "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.5.10.tgz", + "integrity": "sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA==", + "license": "MIT" + }, + "node_modules/http-proxy": { + "version": "1.18.1", + "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.18.1.tgz", + "integrity": "sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==", + "license": "MIT", + "dependencies": { + "eventemitter3": "^4.0.0", + "follow-redirects": "^1.0.0", + "requires-port": "^1.0.0" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/http-proxy-middleware": { + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz", + "integrity": "sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q==", + "license": "MIT", + "dependencies": { + "@types/http-proxy": "^1.17.8", + "http-proxy": "^1.18.1", + "is-glob": "^4.0.1", + "is-plain-obj": "^3.0.0", + "micromatch": "^4.0.2" + }, + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "@types/express": "^4.17.13" + }, + "peerDependenciesMeta": { + "@types/express": { + "optional": true + } + } + }, + "node_modules/http-proxy-middleware/node_modules/is-plain-obj": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-3.0.0.tgz", + "integrity": "sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/http2-wrapper": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.2.1.tgz", + "integrity": "sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ==", + "license": "MIT", + "dependencies": { + "quick-lru": "^5.1.1", + "resolve-alpn": "^1.2.0" + }, + "engines": { + "node": ">=10.19.0" + } + }, + "node_modules/human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.17.0" + } + }, + "node_modules/hyperdyperid": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/hyperdyperid/-/hyperdyperid-1.2.0.tgz", + "integrity": "sha512-Y93lCzHYgGWdrJ66yIktxiaGULYc6oGiABxhcO5AufBeOyoIdZF7bIfLaOrbM0iGIOXQQgxxRrFEnb+Y6w1n4A==", + "license": "MIT", + "engines": { + "node": ">=10.18" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/icss-utils": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/icss-utils/-/icss-utils-5.1.0.tgz", + "integrity": "sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA==", + "license": "ISC", + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/ignore": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/image-size": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/image-size/-/image-size-2.0.2.tgz", + "integrity": "sha512-IRqXKlaXwgSMAMtpNzZa1ZAe8m+Sa1770Dhk8VkSsP9LS+iHD62Zd8FQKs8fbPiagBE7BzoFX23cxFnwshpV6w==", + "license": "MIT", + "bin": { + "image-size": "bin/image-size.js" + }, + "engines": { + "node": ">=16.x" + } + }, + "node_modules/immediate": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/immediate/-/immediate-3.3.0.tgz", + "integrity": "sha512-HR7EVodfFUdQCTIeySw+WDRFJlPcLOJbXfwwZ7Oom6tjsvZ3bOkCDJHehQC3nxJrv7+f9XecwazynjU8e4Vw3Q==", + "license": "MIT" + }, + "node_modules/import-fresh": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", + "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", + "license": "MIT", + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "license": "MIT", + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/indent-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", + "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/infima": { + "version": "0.2.0-alpha.45", + "resolved": "https://registry.npmjs.org/infima/-/infima-0.2.0-alpha.45.tgz", + "integrity": "sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw==", + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" + }, + "node_modules/ini": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", + "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/inline-style-parser": { + "version": "0.2.7", + "resolved": "https://registry.npmjs.org/inline-style-parser/-/inline-style-parser-0.2.7.tgz", + "integrity": "sha512-Nb2ctOyNR8DqQoR0OwRG95uNWIC0C1lCgf5Naz5H6Ji72KZ8OcFZLz2P5sNgwlyoJ8Yif11oMuYs5pBQa86csA==", + "license": "MIT" + }, + "node_modules/invariant": { + "version": "2.2.4", + "resolved": "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz", + "integrity": "sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA==", + "license": "MIT", + "dependencies": { + "loose-envify": "^1.0.0" + } + }, + "node_modules/ipaddr.js": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-2.3.0.tgz", + "integrity": "sha512-Zv/pA+ciVFbCSBBjGfaKUya/CcGmUHzTydLMaTwrUUEM2DIEO3iZvueGxmacvmN50fGpGVKeTXpb2LcYQxeVdg==", + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, + "node_modules/is-alphabetical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", + "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-alphanumerical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz", + "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==", + "license": "MIT", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", + "license": "MIT" + }, + "node_modules/is-binary-path": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", + "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "license": "MIT", + "dependencies": { + "binary-extensions": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-ci": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", + "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", + "license": "MIT", + "dependencies": { + "ci-info": "^3.2.0" + }, + "bin": { + "is-ci": "bin.js" + } + }, + "node_modules/is-core-module": { + "version": "2.16.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", + "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", + "license": "MIT", + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-decimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", + "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-docker": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", + "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==", + "license": "MIT", + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-extendable": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", + "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-hexadecimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", + "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-inside-container": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-inside-container/-/is-inside-container-1.0.0.tgz", + "integrity": "sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==", + "license": "MIT", + "dependencies": { + "is-docker": "^3.0.0" + }, + "bin": { + "is-inside-container": "cli.js" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-inside-container/node_modules/is-docker": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", + "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", + "license": "MIT", + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-installed-globally": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", + "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", + "license": "MIT", + "dependencies": { + "global-dirs": "^3.0.0", + "is-path-inside": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-network-error": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/is-network-error/-/is-network-error-1.3.1.tgz", + "integrity": "sha512-6QCxa49rQbmUWLfk0nuGqzql9U8uaV2H6279bRErPBHe/109hCzsLUBUHfbEtvLIHBd6hyXbgedBSHevm43Edw==", + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-npm": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.1.0.tgz", + "integrity": "sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-obj": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", + "integrity": "sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-path-inside": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-plain-obj": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", + "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-plain-object": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", + "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", + "license": "MIT", + "dependencies": { + "isobject": "^3.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-regexp": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", + "integrity": "sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", + "license": "MIT" + }, + "node_modules/is-wsl": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", + "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==", + "license": "MIT", + "dependencies": { + "is-docker": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-yarn-global": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.1.tgz", + "integrity": "sha512-/kppl+R+LO5VmhYSEWARUFjodS25D68gvj8W7z0I7OWhUla5xWu8KL6CtB2V0R6yqhnRgbcaREMr4EEM6htLPQ==", + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/isarray": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", + "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==", + "license": "MIT" + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "license": "ISC" + }, + "node_modules/isobject": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", + "integrity": "sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/jest-util": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.7.0.tgz", + "integrity": "sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==", + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "@types/node": "*", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "graceful-fs": "^4.2.9", + "picomatch": "^2.2.3" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-worker": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.7.0.tgz", + "integrity": "sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==", + "license": "MIT", + "dependencies": { + "@types/node": "*", + "jest-util": "^29.7.0", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-worker/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/jiti": { + "version": "1.21.7", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.7.tgz", + "integrity": "sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A==", + "license": "MIT", + "bin": { + "jiti": "bin/jiti.js" + } + }, + "node_modules/joi": { + "version": "17.13.3", + "resolved": "https://registry.npmjs.org/joi/-/joi-17.13.3.tgz", + "integrity": "sha512-otDA4ldcIx+ZXsKHWmp0YizCweVRZG96J10b0FevjfuncLO1oX59THoAmHkNubYJ+9gWsYsp5k8v4ib6oDv1fA==", + "license": "BSD-3-Clause", + "dependencies": { + "@hapi/hoek": "^9.3.0", + "@hapi/topo": "^5.1.0", + "@sideway/address": "^4.1.5", + "@sideway/formula": "^3.0.1", + "@sideway/pinpoint": "^2.0.0" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "license": "MIT" + }, + "node_modules/js-yaml": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsesc": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", + "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", + "license": "MIT", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/json-buffer": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", + "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", + "license": "MIT" + }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "license": "MIT" + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "license": "MIT", + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/jsonfile": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", + "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "license": "MIT", + "dependencies": { + "json-buffer": "3.0.1" + } + }, + "node_modules/kind-of": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", + "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/klaw-sync": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/klaw-sync/-/klaw-sync-6.0.0.tgz", + "integrity": "sha512-nIeuVSzdCCs6TDPTqI8w1Yre34sSq7AkZ4B3sfOBbI2CgVSB4Du4aLQijFU2+lhAFCwt9+42Hel6lQNIv6AntQ==", + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.1.11" + } + }, + "node_modules/kleur": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", + "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/latest-version": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", + "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", + "license": "MIT", + "dependencies": { + "package-json": "^8.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/launch-editor": { + "version": "2.13.2", + "resolved": "https://registry.npmjs.org/launch-editor/-/launch-editor-2.13.2.tgz", + "integrity": "sha512-4VVDnbOpLXy/s8rdRCSXb+zfMeFR0WlJWpET1iA9CQdlZDfwyLjUuGQzXU4VeOoey6AicSAluWan7Etga6Kcmg==", + "license": "MIT", + "dependencies": { + "picocolors": "^1.1.1", + "shell-quote": "^1.8.3" + } + }, + "node_modules/leven": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", + "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/lilconfig": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.3.tgz", + "integrity": "sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw==", + "license": "MIT", + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/antonk52" + } + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "license": "MIT" + }, + "node_modules/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "uc.micro": "^2.0.0" + } + }, + "node_modules/loader-runner": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.1.tgz", + "integrity": "sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q==", + "license": "MIT", + "engines": { + "node": ">=6.11.5" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/loader-utils": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.4.tgz", + "integrity": "sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw==", + "license": "MIT", + "dependencies": { + "big.js": "^5.2.2", + "emojis-list": "^3.0.0", + "json5": "^2.1.2" + }, + "engines": { + "node": ">=8.9.0" + } + }, + "node_modules/locate-path": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-7.2.0.tgz", + "integrity": "sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA==", + "license": "MIT", + "dependencies": { + "p-locate": "^6.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lodash": { + "version": "4.17.23", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", + "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", + "license": "MIT" + }, + "node_modules/lodash.debounce": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", + "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==", + "license": "MIT" + }, + "node_modules/lodash.memoize": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", + "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==", + "license": "MIT" + }, + "node_modules/lodash.uniq": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.uniq/-/lodash.uniq-4.5.0.tgz", + "integrity": "sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==", + "license": "MIT" + }, + "node_modules/longest-streak": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-3.1.0.tgz", + "integrity": "sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "license": "MIT", + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, + "node_modules/lower-case": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", + "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", + "license": "MIT", + "dependencies": { + "tslib": "^2.0.3" + } + }, + "node_modules/lowercase-keys": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", + "integrity": "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "license": "ISC", + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "license": "MIT" + }, + "node_modules/lunr-languages": { + "version": "1.14.0", + "resolved": "https://registry.npmjs.org/lunr-languages/-/lunr-languages-1.14.0.tgz", + "integrity": "sha512-hWUAb2KqM3L7J5bcrngszzISY4BxrXn/Xhbb9TTCJYEGqlR1nG67/M14sp09+PTIRklobrn57IAxcdcO/ZFyNA==", + "license": "MPL-1.1" + }, + "node_modules/mark.js": { + "version": "8.11.1", + "resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz", + "integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==", + "license": "MIT" + }, + "node_modules/markdown-extensions": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz", + "integrity": "sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==", + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/markdown-it": { + "version": "14.1.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.1.tgz", + "integrity": "sha512-BuU2qnTti9YKgK5N+IeMubp14ZUKUUw7yeJbkjtosvHiP0AZ5c8IAgEMk79D0eC8F23r4Ac/q8cAIFdm2FtyoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, + "node_modules/markdown-table": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.4.tgz", + "integrity": "sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/mdast-util-directive": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-directive/-/mdast-util-directive-3.1.0.tgz", + "integrity": "sha512-I3fNFt+DHmpWCYAT7quoM6lHf9wuqtI+oCOfvILnoicNIqjh5E3dEJWiXuYME2gNe8vl1iMQwyUHa7bgFmak6Q==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-find-and-replace": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.2.tgz", + "integrity": "sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "escape-string-regexp": "^5.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-find-and-replace/node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mdast-util-from-markdown": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.3.tgz", + "integrity": "sha512-W4mAWTvSlKvf8L6J+VN9yLSqQ9AOAAvHuoDAmPkz4dHf553m5gVj2ejadHJhoJmcmxEnOv6Pa8XJhpxE93kb8Q==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark": "^4.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-from-markdown/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/mdast-util-frontmatter": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-frontmatter/-/mdast-util-frontmatter-2.0.1.tgz", + "integrity": "sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "escape-string-regexp": "^5.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "micromark-extension-frontmatter": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-frontmatter/node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mdast-util-gfm": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm/-/mdast-util-gfm-3.1.0.tgz", + "integrity": "sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ==", + "license": "MIT", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-gfm-autolink-literal": "^2.0.0", + "mdast-util-gfm-footnote": "^2.0.0", + "mdast-util-gfm-strikethrough": "^2.0.0", + "mdast-util-gfm-table": "^2.0.0", + "mdast-util-gfm-task-list-item": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-autolink-literal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-autolink-literal/-/mdast-util-gfm-autolink-literal-2.0.1.tgz", + "integrity": "sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-find-and-replace": "^3.0.0", + "micromark-util-character": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-autolink-literal/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/mdast-util-gfm-autolink-literal/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/mdast-util-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-strikethrough": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-strikethrough/-/mdast-util-gfm-strikethrough-2.0.0.tgz", + "integrity": "sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-table": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-table/-/mdast-util-gfm-table-2.0.0.tgz", + "integrity": "sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "markdown-table": "^3.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-task-list-item": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-task-list-item/-/mdast-util-gfm-task-list-item-2.0.0.tgz", + "integrity": "sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz", + "integrity": "sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w==", + "license": "MIT", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-expression": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.1.tgz", + "integrity": "sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-jsx": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.2.0.tgz", + "integrity": "sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-stringify-position": "^4.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdxjs-esm": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz", + "integrity": "sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-phrasing": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz", + "integrity": "sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-hast": { + "version": "13.2.1", + "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.1.tgz", + "integrity": "sha512-cctsq2wp5vTsLIcaymblUriiTcZd0CwWtCbLvrOzYCDZoWyMNV8sZ7krj09FSnsiJi3WVsHLM4k6Dq/yaPyCXA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@ungap/structured-clone": "^1.0.0", + "devlop": "^1.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "trim-lines": "^3.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-markdown": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.2.tgz", + "integrity": "sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "longest-streak": "^3.0.0", + "mdast-util-phrasing": "^4.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz", + "integrity": "sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdn-data": { + "version": "2.0.30", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.30.tgz", + "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==", + "license": "CC0-1.0" + }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true, + "license": "MIT" + }, + "node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/memfs": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/memfs/-/memfs-4.57.1.tgz", + "integrity": "sha512-WvzrWPwMQT+PtbX2Et64R4qXKK0fj/8pO85MrUCzymX3twwCiJCdvntW3HdhG1teLJcHDDLIKx5+c3HckWYZtQ==", + "license": "Apache-2.0", + "dependencies": { + "@jsonjoy.com/fs-core": "4.57.1", + "@jsonjoy.com/fs-fsa": "4.57.1", + "@jsonjoy.com/fs-node": "4.57.1", + "@jsonjoy.com/fs-node-builtins": "4.57.1", + "@jsonjoy.com/fs-node-to-fsa": "4.57.1", + "@jsonjoy.com/fs-node-utils": "4.57.1", + "@jsonjoy.com/fs-print": "4.57.1", + "@jsonjoy.com/fs-snapshot": "4.57.1", + "@jsonjoy.com/json-pack": "^1.11.0", + "@jsonjoy.com/util": "^1.9.0", + "glob-to-regex.js": "^1.0.1", + "thingies": "^2.5.0", + "tree-dump": "^1.0.3", + "tslib": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/merge-descriptors": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz", + "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "license": "MIT" + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/methods": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", + "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/micromark": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", + "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/debug": "^4.0.0", + "debug": "^4.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz", + "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-destination": "^2.0.0", + "micromark-factory-label": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-title": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-html-tag-name": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-directive": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-3.0.2.tgz", + "integrity": "sha512-wjcXHgk+PPdmvR58Le9d7zQYWy+vKEU9Se44p2CrCDPiLr2FMyiT4Fyb5UFKFC66wGB3kPlgD7q3TnoqPS7SZA==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "parse-entities": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-frontmatter": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-frontmatter/-/micromark-extension-frontmatter-2.0.0.tgz", + "integrity": "sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg==", + "license": "MIT", + "dependencies": { + "fault": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-frontmatter/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-frontmatter/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz", + "integrity": "sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w==", + "license": "MIT", + "dependencies": { + "micromark-extension-gfm-autolink-literal": "^2.0.0", + "micromark-extension-gfm-footnote": "^2.0.0", + "micromark-extension-gfm-strikethrough": "^2.0.0", + "micromark-extension-gfm-table": "^2.0.0", + "micromark-extension-gfm-tagfilter": "^2.0.0", + "micromark-extension-gfm-task-list-item": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz", + "integrity": "sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==", + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm-strikethrough": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-strikethrough/-/micromark-extension-gfm-strikethrough-2.1.0.tgz", + "integrity": "sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-strikethrough/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm-table": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz", + "integrity": "sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-gfm-tagfilter": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-tagfilter/-/micromark-extension-gfm-tagfilter-2.0.0.tgz", + "integrity": "sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg==", + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-task-list-item": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-task-list-item/-/micromark-extension-gfm-task-list-item-2.1.0.tgz", + "integrity": "sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-mdx-expression": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.1.tgz", + "integrity": "sha512-dD/ADLJ1AeMvSAKBwO22zG22N4ybhe7kFIZ3LsDI0GlsNr2A3KYxb0LdC1u5rj4Nw+CHKY0RVdnHX8vj8ejm4Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-mdx-jsx": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-jsx/-/micromark-extension-mdx-jsx-3.0.2.tgz", + "integrity": "sha512-e5+q1DjMh62LZAJOnDraSSbDMvGJ8x3cbjygy2qFEi7HCeUT4BDKCvMozPozcD6WmOt6sVvYDNBKhFSz3kjOVQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-extension-mdx-md": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-md/-/micromark-extension-mdx-md-2.0.0.tgz", + "integrity": "sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ==", + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs/-/micromark-extension-mdxjs-3.0.0.tgz", + "integrity": "sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ==", + "license": "MIT", + "dependencies": { + "acorn": "^8.0.0", + "acorn-jsx": "^5.0.0", + "micromark-extension-mdx-expression": "^3.0.0", + "micromark-extension-mdx-jsx": "^3.0.0", + "micromark-extension-mdx-md": "^2.0.0", + "micromark-extension-mdxjs-esm": "^3.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs-esm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs-esm/-/micromark-extension-mdxjs-esm-3.0.0.tgz", + "integrity": "sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs-esm/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdxjs-esm/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-destination": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz", + "integrity": "sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-destination/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-destination/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-label": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz", + "integrity": "sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-mdx-expression": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-factory-mdx-expression/-/micromark-factory-mdx-expression-2.0.3.tgz", + "integrity": "sha512-kQnEtA3vzucU2BkrIa8/VaSAsP+EJ3CKOvhMuJgOEGg9KDC6OAY6nSnNDVRiVNRqj7Y4SlSzcStaH/5jge8JdQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-space": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-1.1.0.tgz", + "integrity": "sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^1.0.0", + "micromark-util-types": "^1.0.0" + } + }, + "node_modules/micromark-factory-space/node_modules/micromark-util-types": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", + "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-title": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz", + "integrity": "sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-factory-whitespace": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz", + "integrity": "sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-character": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-1.2.0.tgz", + "integrity": "sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^1.0.0", + "micromark-util-types": "^1.0.0" + } + }, + "node_modules/micromark-util-character/node_modules/micromark-util-types": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", + "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-chunked": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz", + "integrity": "sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-chunked/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-classify-character": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz", + "integrity": "sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-combine-extensions": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz", + "integrity": "sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-chunked": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz", + "integrity": "sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-decode-string": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-2.0.1.tgz", + "integrity": "sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-encode": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", + "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-events-to-acorn": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-util-events-to-acorn/-/micromark-util-events-to-acorn-2.0.3.tgz", + "integrity": "sha512-jmsiEIiZ1n7X1Rr5k8wVExBQCg5jy4UXVADItHmNk1zkwEVhBuIUKRu3fqv+hs4nxLISi2DQGlqIOGiFxgbfHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-util-events-to-acorn/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-html-tag-name": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz", + "integrity": "sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-normalize-identifier": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz", + "integrity": "sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-normalize-identifier/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-resolve-all": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz", + "integrity": "sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", + "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-subtokenize": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz", + "integrity": "sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-subtokenize/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-symbol": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-1.1.0.tgz", + "integrity": "sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-types": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", + "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark/node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark/node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark/node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "license": "MIT", + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/mime-db": { + "version": "1.33.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz", + "integrity": "sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.18", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz", + "integrity": "sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ==", + "license": "MIT", + "dependencies": { + "mime-db": "~1.33.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/mimic-response": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-4.0.0.tgz", + "integrity": "sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mini-css-extract-plugin": { + "version": "2.10.2", + "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-2.10.2.tgz", + "integrity": "sha512-AOSS0IdEB95ayVkxn5oGzNQwqAi2J0Jb/kKm43t7H73s8+f5873g0yuj0PNvK4dO75mu5DHg4nlgp4k6Kga8eg==", + "license": "MIT", + "dependencies": { + "schema-utils": "^4.0.0", + "tapable": "^2.2.1" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + } + }, + "node_modules/minimalistic-assert": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz", + "integrity": "sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==", + "license": "ISC" + }, + "node_modules/minimatch": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/mrmime": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.1.tgz", + "integrity": "sha512-Y3wQdFg2Va6etvQ5I82yUhGdsKrcYox6p7FfL1LbK2J4V01F9TGlepTIhnK24t7koZibmg82KGglhA1XK5IsLQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/multicast-dns": { + "version": "7.2.5", + "resolved": "https://registry.npmjs.org/multicast-dns/-/multicast-dns-7.2.5.tgz", + "integrity": "sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg==", + "license": "MIT", + "dependencies": { + "dns-packet": "^5.2.2", + "thunky": "^1.0.2" + }, + "bin": { + "multicast-dns": "cli.js" + } + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/negotiator": { + "version": "0.6.4", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.4.tgz", + "integrity": "sha512-myRT3DiWPHqho5PrJaIRyaMv2kgYf0mUVgBNOYMuCH5Ki1yEiQaf/ZJuQ62nvpc44wL5WDbTX7yGJi1Neevw8w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "license": "MIT" + }, + "node_modules/no-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", + "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", + "license": "MIT", + "dependencies": { + "lower-case": "^2.0.2", + "tslib": "^2.0.3" + } + }, + "node_modules/node-emoji": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/node-emoji/-/node-emoji-2.2.0.tgz", + "integrity": "sha512-Z3lTE9pLaJF47NyMhd4ww1yFTAP8YhYI8SleJiHzM46Fgpm5cnNzSl9XfzFNqbaz+VlJrIj3fXQ4DeN1Rjm6cw==", + "license": "MIT", + "dependencies": { + "@sindresorhus/is": "^4.6.0", + "char-regex": "^1.0.2", + "emojilib": "^2.4.0", + "skin-tone": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/node-releases": { + "version": "2.0.36", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.36.tgz", + "integrity": "sha512-TdC8FSgHz8Mwtw9g5L4gR/Sh9XhSP/0DEkQxfEFXOpiul5IiHgHan2VhYYb6agDSfp4KuvltmGApc8HMgUrIkA==", + "license": "MIT" + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/normalize-url": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-8.1.1.tgz", + "integrity": "sha512-JYc0DPlpGWB40kH5g07gGTrYuMqV653k3uBKY6uITPWds3M0ov3GaWGp9lbE3Bzngx8+XkfzgvASb9vk9JDFXQ==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "license": "MIT", + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/nprogress": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/nprogress/-/nprogress-0.2.0.tgz", + "integrity": "sha512-I19aIingLgR1fmhftnbWWO3dXc0hSxqHQHQb3H8m+K3TnEn/iSeTZZOyvKXWqQESMwuUVnatlCnZdLBZZt2VSA==", + "license": "MIT" + }, + "node_modules/nth-check": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", + "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0" + }, + "funding": { + "url": "https://github.com/fb55/nth-check?sponsor=1" + } + }, + "node_modules/null-loader": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/null-loader/-/null-loader-4.0.1.tgz", + "integrity": "sha512-pxqVbi4U6N26lq+LmgIbB5XATP0VdZKOG25DhHi8btMmJJefGArFyDg1yc4U3hWCJbMqSrw0qyrz1UQX+qYXqg==", + "license": "MIT", + "dependencies": { + "loader-utils": "^2.0.0", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/null-loader/node_modules/ajv": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", + "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/null-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "license": "MIT", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/null-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "license": "MIT" + }, + "node_modules/null-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", + "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0", + "has-symbols": "^1.1.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/obuf": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/obuf/-/obuf-1.1.2.tgz", + "integrity": "sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg==", + "license": "MIT" + }, + "node_modules/on-finished": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", + "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", + "license": "MIT", + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/on-headers": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/on-headers/-/on-headers-1.1.0.tgz", + "integrity": "sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "license": "MIT", + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/open": { + "version": "8.4.2", + "resolved": "https://registry.npmjs.org/open/-/open-8.4.2.tgz", + "integrity": "sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==", + "license": "MIT", + "dependencies": { + "define-lazy-prop": "^2.0.0", + "is-docker": "^2.1.1", + "is-wsl": "^2.2.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/opener": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", + "integrity": "sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==", + "license": "(WTFPL OR MIT)", + "bin": { + "opener": "bin/opener-bin.js" + } + }, + "node_modules/p-cancelable": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-3.0.0.tgz", + "integrity": "sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw==", + "license": "MIT", + "engines": { + "node": ">=12.20" + } + }, + "node_modules/p-finally": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", + "integrity": "sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/p-limit": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-4.0.0.tgz", + "integrity": "sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ==", + "license": "MIT", + "dependencies": { + "yocto-queue": "^1.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-6.0.0.tgz", + "integrity": "sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw==", + "license": "MIT", + "dependencies": { + "p-limit": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-map": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", + "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", + "license": "MIT", + "dependencies": { + "aggregate-error": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-queue": { + "version": "6.6.2", + "resolved": "https://registry.npmjs.org/p-queue/-/p-queue-6.6.2.tgz", + "integrity": "sha512-RwFpb72c/BhQLEXIZ5K2e+AhgNVmIejGlTgiB9MzZ0e93GRvqZ7uSi0dvRF7/XIXDeNkra2fNHBxTyPDGySpjQ==", + "license": "MIT", + "dependencies": { + "eventemitter3": "^4.0.4", + "p-timeout": "^3.2.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-retry": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/p-retry/-/p-retry-6.2.1.tgz", + "integrity": "sha512-hEt02O4hUct5wtwg4H4KcWgDdm+l1bOaEy/hWzd8xtXB9BqxTWBBhb+2ImAtH4Cv4rPjV76xN3Zumqk3k3AhhQ==", + "license": "MIT", + "dependencies": { + "@types/retry": "0.12.2", + "is-network-error": "^1.0.0", + "retry": "^0.13.1" + }, + "engines": { + "node": ">=16.17" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-timeout": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/p-timeout/-/p-timeout-3.2.0.tgz", + "integrity": "sha512-rhIwUycgwwKcP9yTOOFK/AKsAopjjCakVqLHePO3CC6Mir1Z99xT+R63jZxAT5lFZLa2inS5h+ZS2GvR99/FBg==", + "license": "MIT", + "dependencies": { + "p-finally": "^1.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/package-json": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.1.tgz", + "integrity": "sha512-cbH9IAIJHNj9uXi196JVsRlt7cHKak6u/e6AkL/bkRelZ7rlL3X1YKxsZwa36xipOEKAsdtmaG6aAJoM1fx2zA==", + "license": "MIT", + "dependencies": { + "got": "^12.1.0", + "registry-auth-token": "^5.0.1", + "registry-url": "^6.0.0", + "semver": "^7.3.7" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/param-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", + "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", + "license": "MIT", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "license": "MIT", + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-entities": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.2.tgz", + "integrity": "sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^2.0.0", + "character-entities-legacy": "^3.0.0", + "character-reference-invalid": "^2.0.0", + "decode-named-character-reference": "^1.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0", + "is-hexadecimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/parse-entities/node_modules/@types/unist": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.11.tgz", + "integrity": "sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==", + "license": "MIT" + }, + "node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parse-numeric-range": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz", + "integrity": "sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ==", + "license": "ISC" + }, + "node_modules/parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "license": "MIT", + "dependencies": { + "entities": "^6.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-htmlparser2-tree-adapter": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz", + "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==", + "license": "MIT", + "dependencies": { + "domhandler": "^5.0.3", + "parse5": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-parser-stream": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/parse5-parser-stream/-/parse5-parser-stream-7.1.2.tgz", + "integrity": "sha512-JyeQc9iwFLn5TbvvqACIF/VXG6abODeB3Fwmv/TGdLk2LfbWkaySGY72at4+Ty7EkPZj854u4CrICqNk2qIbow==", + "license": "MIT", + "dependencies": { + "parse5": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5/node_modules/entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/parseurl": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", + "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/pascal-case": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", + "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/path-exists": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-5.0.0.tgz", + "integrity": "sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + } + }, + "node_modules/path-is-inside": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", + "integrity": "sha512-DUWJr3+ULp4zXmol/SZkFf3JGsS9/SIv+Y3Rt93/UjPpDpklB5f1er4O3POIbUuUJ3FXgqte2Q7SrU6zAqwk8w==", + "license": "(WTFPL OR MIT)" + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "license": "MIT" + }, + "node_modules/path-to-regexp": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", + "integrity": "sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g==", + "license": "MIT", + "dependencies": { + "isarray": "0.0.1" + } + }, + "node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pkg-dir": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-7.0.0.tgz", + "integrity": "sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA==", + "license": "MIT", + "dependencies": { + "find-up": "^6.3.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkijs": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/pkijs/-/pkijs-3.4.0.tgz", + "integrity": "sha512-emEcLuomt2j03vxD54giVB4SxTjnsqkU692xZOZXHDVoYyypEm+b3jpiTcc+Cf+myooc+/Ly0z01jqeNHVgJGw==", + "license": "BSD-3-Clause", + "dependencies": { + "@noble/hashes": "1.4.0", + "asn1js": "^3.0.6", + "bytestreamjs": "^2.0.1", + "pvtsutils": "^1.3.6", + "pvutils": "^1.1.3", + "tslib": "^2.8.1" + }, + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/postcss": { + "version": "8.5.8", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz", + "integrity": "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/postcss-attribute-case-insensitive": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/postcss-attribute-case-insensitive/-/postcss-attribute-case-insensitive-7.0.1.tgz", + "integrity": "sha512-Uai+SupNSqzlschRyNx3kbCTWgY/2hcwtHEI/ej2LJWc9JJ77qKgGptd8DHwY1mXtZ7Aoh4z4yxfwMBue9eNgw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-attribute-case-insensitive/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-calc": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/postcss-calc/-/postcss-calc-9.0.1.tgz", + "integrity": "sha512-TipgjGyzP5QzEhsOZUaIkeO5mKeMFpebWzRogWG/ysonUlnHcq5aJe0jOjpfzUU8PeSaBQnrE8ehR0QA5vs8PQ==", + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.0.11", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.2.2" + } + }, + "node_modules/postcss-clamp": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/postcss-clamp/-/postcss-clamp-4.1.0.tgz", + "integrity": "sha512-ry4b1Llo/9zz+PKC+030KUnPITTJAHeOwjfAyyB60eT0AorGLdzp52s31OsPRHRf8NchkgFoG2y6fCfn1IV1Ow==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=7.6.0" + }, + "peerDependencies": { + "postcss": "^8.4.6" + } + }, + "node_modules/postcss-color-functional-notation": { + "version": "7.0.12", + "resolved": "https://registry.npmjs.org/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.12.tgz", + "integrity": "sha512-TLCW9fN5kvO/u38/uesdpbx3e8AkTYhMvDZYa9JpmImWuTE99bDQ7GU7hdOADIZsiI9/zuxfAJxny/khknp1Zw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-color-hex-alpha": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/postcss-color-hex-alpha/-/postcss-color-hex-alpha-10.0.0.tgz", + "integrity": "sha512-1kervM2cnlgPs2a8Vt/Qbe5cQ++N7rkYo/2rz2BkqJZIHQwaVuJgQH38REHrAi4uM0b1fqxMkWYmese94iMp3w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-color-rebeccapurple": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/postcss-color-rebeccapurple/-/postcss-color-rebeccapurple-10.0.0.tgz", + "integrity": "sha512-JFta737jSP+hdAIEhk1Vs0q0YF5P8fFcj+09pweS8ktuGuZ8pPlykHsk6mPxZ8awDl4TrcxUqJo9l1IhVr/OjQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-colormin": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-colormin/-/postcss-colormin-6.1.0.tgz", + "integrity": "sha512-x9yX7DOxeMAR+BgGVnNSAxmAj98NX/YxEMNFP+SDCEeNLb2r3i6Hh1ksMsnW8Ub5SLCpbescQqn9YEbE9554Sw==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0", + "colord": "^2.9.3", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-convert-values": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-convert-values/-/postcss-convert-values-6.1.0.tgz", + "integrity": "sha512-zx8IwP/ts9WvUM6NkVSkiU902QZL1bwPhaVaLynPtCsOTqp+ZKbNi+s6XJg3rfqpKGA/oc7Oxk5t8pOQJcwl/w==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-custom-media": { + "version": "11.0.6", + "resolved": "https://registry.npmjs.org/postcss-custom-media/-/postcss-custom-media-11.0.6.tgz", + "integrity": "sha512-C4lD4b7mUIw+RZhtY7qUbf4eADmb7Ey8BFA2px9jUbwg7pjTZDl4KY4bvlUV+/vXQvzQRfiGEVJyAbtOsCMInw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/cascade-layer-name-parser": "^2.0.5", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/media-query-list-parser": "^4.0.3" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-custom-properties": { + "version": "14.0.6", + "resolved": "https://registry.npmjs.org/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz", + "integrity": "sha512-fTYSp3xuk4BUeVhxCSJdIPhDLpJfNakZKoiTDx7yRGCdlZrSJR7mWKVOBS4sBF+5poPQFMj2YdXx1VHItBGihQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/cascade-layer-name-parser": "^2.0.5", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-custom-selectors": { + "version": "8.0.5", + "resolved": "https://registry.npmjs.org/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz", + "integrity": "sha512-9PGmckHQswiB2usSO6XMSswO2yFWVoCAuih1yl9FVcwkscLjRKjwsjM3t+NIWpSU2Jx3eOiK2+t4vVTQaoCHHg==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "@csstools/cascade-layer-name-parser": "^2.0.5", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-custom-selectors/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-dir-pseudo-class": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/postcss-dir-pseudo-class/-/postcss-dir-pseudo-class-9.0.1.tgz", + "integrity": "sha512-tRBEK0MHYvcMUrAuYMEOa0zg9APqirBcgzi6P21OhxtJyJADo/SWBwY1CAwEohQ/6HDaa9jCjLRG7K3PVQYHEA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-dir-pseudo-class/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-discard-comments": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-discard-comments/-/postcss-discard-comments-6.0.2.tgz", + "integrity": "sha512-65w/uIqhSBBfQmYnG92FO1mWZjJ4GL5b8atm5Yw2UgrwD7HiNiSSNwJor1eCFGzUgYnN/iIknhNRVqjrrpuglw==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-duplicates": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-discard-duplicates/-/postcss-discard-duplicates-6.0.3.tgz", + "integrity": "sha512-+JA0DCvc5XvFAxwx6f/e68gQu/7Z9ud584VLmcgto28eB8FqSFZwtrLwB5Kcp70eIoWP/HXqz4wpo8rD8gpsTw==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-empty": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-discard-empty/-/postcss-discard-empty-6.0.3.tgz", + "integrity": "sha512-znyno9cHKQsK6PtxL5D19Fj9uwSzC2mB74cpT66fhgOadEUPyXFkbgwm5tvc3bt3NAy8ltE5MrghxovZRVnOjQ==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-overridden": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-discard-overridden/-/postcss-discard-overridden-6.0.2.tgz", + "integrity": "sha512-j87xzI4LUggC5zND7KdjsI25APtyMuynXZSujByMaav2roV6OZX+8AaCUcZSWqckZpjAjRyFDdpqybgjFO0HJQ==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-unused": { + "version": "6.0.5", + "resolved": "https://registry.npmjs.org/postcss-discard-unused/-/postcss-discard-unused-6.0.5.tgz", + "integrity": "sha512-wHalBlRHkaNnNwfC8z+ppX57VhvS+HWgjW508esjdaEYr3Mx7Gnn2xA4R/CKf5+Z9S5qsqC+Uzh4ueENWwCVUA==", + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-double-position-gradients": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.4.tgz", + "integrity": "sha512-m6IKmxo7FxSP5nF2l63QbCC3r+bWpFUWmZXZf096WxG0m7Vl1Q1+ruFOhpdDRmKrRS+S3Jtk+TVk/7z0+BVK6g==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-focus-visible": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/postcss-focus-visible/-/postcss-focus-visible-10.0.1.tgz", + "integrity": "sha512-U58wyjS/I1GZgjRok33aE8juW9qQgQUNwTSdxQGuShHzwuYdcklnvK/+qOWX1Q9kr7ysbraQ6ht6r+udansalA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-focus-visible/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-focus-within": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/postcss-focus-within/-/postcss-focus-within-9.0.1.tgz", + "integrity": "sha512-fzNUyS1yOYa7mOjpci/bR+u+ESvdar6hk8XNK/TRR0fiGTp2QT5N+ducP0n3rfH/m9I7H/EQU6lsa2BrgxkEjw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-focus-within/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-font-variant": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/postcss-font-variant/-/postcss-font-variant-5.0.0.tgz", + "integrity": "sha512-1fmkBaCALD72CK2a9i468mA/+tr9/1cBxRRMXOUaZqO43oWPR5imcyPjXwuv7PXbCid4ndlP5zWhidQVVa3hmA==", + "license": "MIT", + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-gap-properties": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/postcss-gap-properties/-/postcss-gap-properties-6.0.0.tgz", + "integrity": "sha512-Om0WPjEwiM9Ru+VhfEDPZJAKWUd0mV1HmNXqp2C29z80aQ2uP9UVhLc7e3aYMIor/S5cVhoPgYQ7RtfeZpYTRw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-image-set-function": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/postcss-image-set-function/-/postcss-image-set-function-7.0.0.tgz", + "integrity": "sha512-QL7W7QNlZuzOwBTeXEmbVckNt1FSmhQtbMRvGGqqU4Nf4xk6KUEQhAoWuMzwbSv5jxiRiSZ5Tv7eiDB9U87znA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/utilities": "^2.0.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-lab-function": { + "version": "7.0.12", + "resolved": "https://registry.npmjs.org/postcss-lab-function/-/postcss-lab-function-7.0.12.tgz", + "integrity": "sha512-tUcyRk1ZTPec3OuKFsqtRzW2Go5lehW29XA21lZ65XmzQkz43VY2tyWEC202F7W3mILOjw0voOiuxRGTsN+J9w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/css-color-parser": "^3.1.0", + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/utilities": "^2.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-loader": { + "version": "7.3.4", + "resolved": "https://registry.npmjs.org/postcss-loader/-/postcss-loader-7.3.4.tgz", + "integrity": "sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A==", + "license": "MIT", + "dependencies": { + "cosmiconfig": "^8.3.5", + "jiti": "^1.20.0", + "semver": "^7.5.4" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "postcss": "^7.0.0 || ^8.0.1", + "webpack": "^5.0.0" + } + }, + "node_modules/postcss-logical": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/postcss-logical/-/postcss-logical-8.1.0.tgz", + "integrity": "sha512-pL1hXFQ2fEXNKiNiAgtfA005T9FBxky5zkX6s4GZM2D8RkVgRqz3f4g1JUoq925zXv495qk8UNldDwh8uGEDoA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-merge-idents": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-merge-idents/-/postcss-merge-idents-6.0.3.tgz", + "integrity": "sha512-1oIoAsODUs6IHQZkLQGO15uGEbK3EAl5wi9SS8hs45VgsxQfMnxvt+L+zIr7ifZFIH14cfAeVe2uCTa+SPRa3g==", + "license": "MIT", + "dependencies": { + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-merge-longhand": { + "version": "6.0.5", + "resolved": "https://registry.npmjs.org/postcss-merge-longhand/-/postcss-merge-longhand-6.0.5.tgz", + "integrity": "sha512-5LOiordeTfi64QhICp07nzzuTDjNSO8g5Ksdibt44d+uvIIAE1oZdRn8y/W5ZtYgRH/lnLDlvi9F8btZcVzu3w==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0", + "stylehacks": "^6.1.1" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-merge-rules": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/postcss-merge-rules/-/postcss-merge-rules-6.1.1.tgz", + "integrity": "sha512-KOdWF0gju31AQPZiD+2Ar9Qjowz1LTChSjFFbS+e2sFgc4uHOp3ZvVX4sNeTlk0w2O31ecFGgrFzhO0RSWbWwQ==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0", + "cssnano-utils": "^4.0.2", + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-font-values": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-minify-font-values/-/postcss-minify-font-values-6.1.0.tgz", + "integrity": "sha512-gklfI/n+9rTh8nYaSJXlCo3nOKqMNkxuGpTn/Qm0gstL3ywTr9/WRKznE+oy6fvfolH6dF+QM4nCo8yPLdvGJg==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-gradients": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-minify-gradients/-/postcss-minify-gradients-6.0.3.tgz", + "integrity": "sha512-4KXAHrYlzF0Rr7uc4VrfwDJ2ajrtNEpNEuLxFgwkhFZ56/7gaE4Nr49nLsQDZyUe+ds+kEhf+YAUolJiYXF8+Q==", + "license": "MIT", + "dependencies": { + "colord": "^2.9.3", + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-params": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-minify-params/-/postcss-minify-params-6.1.0.tgz", + "integrity": "sha512-bmSKnDtyyE8ujHQK0RQJDIKhQ20Jq1LYiez54WiaOoBtcSuflfK3Nm596LvbtlFcpipMjgClQGyGr7GAs+H1uA==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-selectors": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/postcss-minify-selectors/-/postcss-minify-selectors-6.0.4.tgz", + "integrity": "sha512-L8dZSwNLgK7pjTto9PzWRoMbnLq5vsZSTu8+j1P/2GB8qdtGQfn+K1uSvFgYvgh83cbyxT5m43ZZhUMTJDSClQ==", + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-modules-extract-imports": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/postcss-modules-extract-imports/-/postcss-modules-extract-imports-3.1.0.tgz", + "integrity": "sha512-k3kNe0aNFQDAZGbin48pL2VNidTF0w4/eASDsxlyspobzU3wZQLOGj7L9gfRe0Jo9/4uud09DsjFNH7winGv8Q==", + "license": "ISC", + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-local-by-default": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/postcss-modules-local-by-default/-/postcss-modules-local-by-default-4.2.0.tgz", + "integrity": "sha512-5kcJm/zk+GJDSfw+V/42fJ5fhjL5YbFDl8nVdXkJPLLW+Vf9mTD5Xe0wqIaDnLuL2U6cDNpTr+UQ+v2HWIBhzw==", + "license": "MIT", + "dependencies": { + "icss-utils": "^5.0.0", + "postcss-selector-parser": "^7.0.0", + "postcss-value-parser": "^4.1.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-local-by-default/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-modules-scope": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/postcss-modules-scope/-/postcss-modules-scope-3.2.1.tgz", + "integrity": "sha512-m9jZstCVaqGjTAuny8MdgE88scJnCiQSlSrOWcTQgM2t32UBe+MUmFSO5t7VMSfAf/FJKImAxBav8ooCHJXCJA==", + "license": "ISC", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-scope/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-modules-values": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/postcss-modules-values/-/postcss-modules-values-4.0.0.tgz", + "integrity": "sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ==", + "license": "ISC", + "dependencies": { + "icss-utils": "^5.0.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-nesting": { + "version": "13.0.2", + "resolved": "https://registry.npmjs.org/postcss-nesting/-/postcss-nesting-13.0.2.tgz", + "integrity": "sha512-1YCI290TX+VP0U/K/aFxzHzQWHWURL+CtHMSbex1lCdpXD1SoR2sYuxDu5aNI9lPoXpKTCggFZiDJbwylU0LEQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/selector-resolve-nested": "^3.1.0", + "@csstools/selector-specificity": "^5.0.0", + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-nesting/node_modules/@csstools/selector-resolve-nested": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.1.0.tgz", + "integrity": "sha512-mf1LEW0tJLKfWyvn5KdDrhpxHyuxpbNwTIwOYLIvsTffeyOf85j5oIzfG0yosxDgx/sswlqBnESYUcQH0vgZ0g==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/postcss-nesting/node_modules/@csstools/selector-specificity": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", + "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss-selector-parser": "^7.0.0" + } + }, + "node_modules/postcss-nesting/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-normalize-charset": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-charset/-/postcss-normalize-charset-6.0.2.tgz", + "integrity": "sha512-a8N9czmdnrjPHa3DeFlwqst5eaL5W8jYu3EBbTTkI5FHkfMhFZh1EGbku6jhHhIzTA6tquI2P42NtZ59M/H/kQ==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-display-values": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-display-values/-/postcss-normalize-display-values-6.0.2.tgz", + "integrity": "sha512-8H04Mxsb82ON/aAkPeq8kcBbAtI5Q2a64X/mnRRfPXBq7XeogoQvReqxEfc0B4WPq1KimjezNC8flUtC3Qz6jg==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-positions": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-positions/-/postcss-normalize-positions-6.0.2.tgz", + "integrity": "sha512-/JFzI441OAB9O7VnLA+RtSNZvQ0NCFZDOtp6QPFo1iIyawyXg0YI3CYM9HBy1WvwCRHnPep/BvI1+dGPKoXx/Q==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-repeat-style": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-6.0.2.tgz", + "integrity": "sha512-YdCgsfHkJ2jEXwR4RR3Tm/iOxSfdRt7jplS6XRh9Js9PyCR/aka/FCb6TuHT2U8gQubbm/mPmF6L7FY9d79VwQ==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-string": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-string/-/postcss-normalize-string-6.0.2.tgz", + "integrity": "sha512-vQZIivlxlfqqMp4L9PZsFE4YUkWniziKjQWUtsxUiVsSSPelQydwS8Wwcuw0+83ZjPWNTl02oxlIvXsmmG+CiQ==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-timing-functions": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-6.0.2.tgz", + "integrity": "sha512-a+YrtMox4TBtId/AEwbA03VcJgtyW4dGBizPl7e88cTFULYsprgHWTbfyjSLyHeBcK/Q9JhXkt2ZXiwaVHoMzA==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-unicode": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-normalize-unicode/-/postcss-normalize-unicode-6.1.0.tgz", + "integrity": "sha512-QVC5TQHsVj33otj8/JD869Ndr5Xcc/+fwRh4HAsFsAeygQQXm+0PySrKbr/8tkDKzW+EVT3QkqZMfFrGiossDg==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-url": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-url/-/postcss-normalize-url-6.0.2.tgz", + "integrity": "sha512-kVNcWhCeKAzZ8B4pv/DnrU1wNh458zBNp8dh4y5hhxih5RZQ12QWMuQrDgPRw3LRl8mN9vOVfHl7uhvHYMoXsQ==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-whitespace": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-whitespace/-/postcss-normalize-whitespace-6.0.2.tgz", + "integrity": "sha512-sXZ2Nj1icbJOKmdjXVT9pnyHQKiSAyuNQHSgRCUgThn2388Y9cGVDR+E9J9iAYbSbLHI+UUwLVl1Wzco/zgv0Q==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-opacity-percentage": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/postcss-opacity-percentage/-/postcss-opacity-percentage-3.0.0.tgz", + "integrity": "sha512-K6HGVzyxUxd/VgZdX04DCtdwWJ4NGLG212US4/LA1TLAbHgmAsTWVR86o+gGIbFtnTkfOpb9sCRBx8K7HO66qQ==", + "funding": [ + { + "type": "kofi", + "url": "https://ko-fi.com/mrcgrtz" + }, + { + "type": "liberapay", + "url": "https://liberapay.com/mrcgrtz" + } + ], + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-ordered-values": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-ordered-values/-/postcss-ordered-values-6.0.2.tgz", + "integrity": "sha512-VRZSOB+JU32RsEAQrO94QPkClGPKJEL/Z9PCBImXMhIeK5KAYo6slP/hBYlLgrCjFxyqvn5VC81tycFEDBLG1Q==", + "license": "MIT", + "dependencies": { + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-overflow-shorthand": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/postcss-overflow-shorthand/-/postcss-overflow-shorthand-6.0.0.tgz", + "integrity": "sha512-BdDl/AbVkDjoTofzDQnwDdm/Ym6oS9KgmO7Gr+LHYjNWJ6ExORe4+3pcLQsLA9gIROMkiGVjjwZNoL/mpXHd5Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-page-break": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/postcss-page-break/-/postcss-page-break-3.0.4.tgz", + "integrity": "sha512-1JGu8oCjVXLa9q9rFTo4MbeeA5FMe00/9C7lN4va606Rdb+HkxXtXsmEDrIraQ11fGz/WvKWa8gMuCKkrXpTsQ==", + "license": "MIT", + "peerDependencies": { + "postcss": "^8" + } + }, + "node_modules/postcss-place": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/postcss-place/-/postcss-place-10.0.0.tgz", + "integrity": "sha512-5EBrMzat2pPAxQNWYavwAfoKfYcTADJ8AXGVPcUZ2UkNloUTWzJQExgrzrDkh3EKzmAx1evfTAzF9I8NGcc+qw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-preset-env": { + "version": "10.6.1", + "resolved": "https://registry.npmjs.org/postcss-preset-env/-/postcss-preset-env-10.6.1.tgz", + "integrity": "sha512-yrk74d9EvY+W7+lO9Aj1QmjWY9q5NsKjK2V9drkOPZB/X6KZ0B3igKsHUYakb7oYVhnioWypQX3xGuePf89f3g==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "@csstools/postcss-alpha-function": "^1.0.1", + "@csstools/postcss-cascade-layers": "^5.0.2", + "@csstools/postcss-color-function": "^4.0.12", + "@csstools/postcss-color-function-display-p3-linear": "^1.0.1", + "@csstools/postcss-color-mix-function": "^3.0.12", + "@csstools/postcss-color-mix-variadic-function-arguments": "^1.0.2", + "@csstools/postcss-content-alt-text": "^2.0.8", + "@csstools/postcss-contrast-color-function": "^2.0.12", + "@csstools/postcss-exponential-functions": "^2.0.9", + "@csstools/postcss-font-format-keywords": "^4.0.0", + "@csstools/postcss-gamut-mapping": "^2.0.11", + "@csstools/postcss-gradients-interpolation-method": "^5.0.12", + "@csstools/postcss-hwb-function": "^4.0.12", + "@csstools/postcss-ic-unit": "^4.0.4", + "@csstools/postcss-initial": "^2.0.1", + "@csstools/postcss-is-pseudo-class": "^5.0.3", + "@csstools/postcss-light-dark-function": "^2.0.11", + "@csstools/postcss-logical-float-and-clear": "^3.0.0", + "@csstools/postcss-logical-overflow": "^2.0.0", + "@csstools/postcss-logical-overscroll-behavior": "^2.0.0", + "@csstools/postcss-logical-resize": "^3.0.0", + "@csstools/postcss-logical-viewport-units": "^3.0.4", + "@csstools/postcss-media-minmax": "^2.0.9", + "@csstools/postcss-media-queries-aspect-ratio-number-values": "^3.0.5", + "@csstools/postcss-nested-calc": "^4.0.0", + "@csstools/postcss-normalize-display-values": "^4.0.1", + "@csstools/postcss-oklab-function": "^4.0.12", + "@csstools/postcss-position-area-property": "^1.0.0", + "@csstools/postcss-progressive-custom-properties": "^4.2.1", + "@csstools/postcss-property-rule-prelude-list": "^1.0.0", + "@csstools/postcss-random-function": "^2.0.1", + "@csstools/postcss-relative-color-syntax": "^3.0.12", + "@csstools/postcss-scope-pseudo-class": "^4.0.1", + "@csstools/postcss-sign-functions": "^1.1.4", + "@csstools/postcss-stepped-value-functions": "^4.0.9", + "@csstools/postcss-syntax-descriptor-syntax-production": "^1.0.1", + "@csstools/postcss-system-ui-font-family": "^1.0.0", + "@csstools/postcss-text-decoration-shorthand": "^4.0.3", + "@csstools/postcss-trigonometric-functions": "^4.0.9", + "@csstools/postcss-unset-value": "^4.0.0", + "autoprefixer": "^10.4.23", + "browserslist": "^4.28.1", + "css-blank-pseudo": "^7.0.1", + "css-has-pseudo": "^7.0.3", + "css-prefers-color-scheme": "^10.0.0", + "cssdb": "^8.6.0", + "postcss-attribute-case-insensitive": "^7.0.1", + "postcss-clamp": "^4.1.0", + "postcss-color-functional-notation": "^7.0.12", + "postcss-color-hex-alpha": "^10.0.0", + "postcss-color-rebeccapurple": "^10.0.0", + "postcss-custom-media": "^11.0.6", + "postcss-custom-properties": "^14.0.6", + "postcss-custom-selectors": "^8.0.5", + "postcss-dir-pseudo-class": "^9.0.1", + "postcss-double-position-gradients": "^6.0.4", + "postcss-focus-visible": "^10.0.1", + "postcss-focus-within": "^9.0.1", + "postcss-font-variant": "^5.0.0", + "postcss-gap-properties": "^6.0.0", + "postcss-image-set-function": "^7.0.0", + "postcss-lab-function": "^7.0.12", + "postcss-logical": "^8.1.0", + "postcss-nesting": "^13.0.2", + "postcss-opacity-percentage": "^3.0.0", + "postcss-overflow-shorthand": "^6.0.0", + "postcss-page-break": "^3.0.4", + "postcss-place": "^10.0.0", + "postcss-pseudo-class-any-link": "^10.0.1", + "postcss-replace-overflow-wrap": "^4.0.0", + "postcss-selector-not": "^8.0.1" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-pseudo-class-any-link": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/postcss-pseudo-class-any-link/-/postcss-pseudo-class-any-link-10.0.1.tgz", + "integrity": "sha512-3el9rXlBOqTFaMFkWDOkHUTQekFIYnaQY55Rsp8As8QQkpiSgIYEcF/6Ond93oHiDsGb4kad8zjt+NPlOC1H0Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT-0", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-pseudo-class-any-link/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-reduce-idents": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-reduce-idents/-/postcss-reduce-idents-6.0.3.tgz", + "integrity": "sha512-G3yCqZDpsNPoQgbDUy3T0E6hqOQ5xigUtBQyrmq3tn2GxlyiL0yyl7H+T8ulQR6kOcHJ9t7/9H4/R2tv8tJbMA==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-reduce-initial": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-reduce-initial/-/postcss-reduce-initial-6.1.0.tgz", + "integrity": "sha512-RarLgBK/CrL1qZags04oKbVbrrVK2wcxhvta3GCxrZO4zveibqbRPmm2VI8sSgCXwoUHEliRSbOfpR0b/VIoiw==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-reduce-transforms": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-reduce-transforms/-/postcss-reduce-transforms-6.0.2.tgz", + "integrity": "sha512-sB+Ya++3Xj1WaT9+5LOOdirAxP7dJZms3GRcYheSPi1PiTMigsxHAdkrbItHxwYHr4kt1zL7mmcHstgMYT+aiA==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-replace-overflow-wrap": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/postcss-replace-overflow-wrap/-/postcss-replace-overflow-wrap-4.0.0.tgz", + "integrity": "sha512-KmF7SBPphT4gPPcKZc7aDkweHiKEEO8cla/GjcBK+ckKxiZslIu3C4GCRW3DNfL0o7yW7kMQu9xlZ1kXRXLXtw==", + "license": "MIT", + "peerDependencies": { + "postcss": "^8.0.3" + } + }, + "node_modules/postcss-selector-not": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/postcss-selector-not/-/postcss-selector-not-8.0.1.tgz", + "integrity": "sha512-kmVy/5PYVb2UOhy0+LqUYAhKj7DUGDpSWa5LZqlkWJaaAV+dxxsOG3+St0yNLu6vsKD7Dmqx+nWQt0iil89+WA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/csstools" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/csstools" + } + ], + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "postcss": "^8.4" + } + }, + "node_modules/postcss-selector-not/node_modules/postcss-selector-parser": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", + "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-selector-parser": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz", + "integrity": "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-sort-media-queries": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/postcss-sort-media-queries/-/postcss-sort-media-queries-5.2.0.tgz", + "integrity": "sha512-AZ5fDMLD8SldlAYlvi8NIqo0+Z8xnXU2ia0jxmuhxAU+Lqt9K+AlmLNJ/zWEnE9x+Zx3qL3+1K20ATgNOr3fAA==", + "license": "MIT", + "dependencies": { + "sort-css-media-queries": "2.2.0" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "postcss": "^8.4.23" + } + }, + "node_modules/postcss-svgo": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-svgo/-/postcss-svgo-6.0.3.tgz", + "integrity": "sha512-dlrahRmxP22bX6iKEjOM+c8/1p+81asjKT+V5lrgOH944ryx/OHpclnIbGsKVd3uWOXFLYJwCVf0eEkJGvO96g==", + "license": "MIT", + "dependencies": { + "postcss-value-parser": "^4.2.0", + "svgo": "^3.2.0" + }, + "engines": { + "node": "^14 || ^16 || >= 18" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-unique-selectors": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/postcss-unique-selectors/-/postcss-unique-selectors-6.0.4.tgz", + "integrity": "sha512-K38OCaIrO8+PzpArzkLKB42dSARtC2tmG6PvD4b1o1Q2E9Os8jzfWFfSy/rixsHwohtsDdFtAWGjFVFUdwYaMg==", + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-value-parser": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz", + "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==", + "license": "MIT" + }, + "node_modules/postcss-zindex": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-zindex/-/postcss-zindex-6.0.2.tgz", + "integrity": "sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg==", + "license": "MIT", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/pretty-error": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz", + "integrity": "sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw==", + "license": "MIT", + "dependencies": { + "lodash": "^4.17.20", + "renderkid": "^3.0.0" + } + }, + "node_modules/pretty-time": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/pretty-time/-/pretty-time-1.1.0.tgz", + "integrity": "sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/prism-react-renderer": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/prism-react-renderer/-/prism-react-renderer-2.4.1.tgz", + "integrity": "sha512-ey8Ls/+Di31eqzUxC46h8MksNuGx/n0AAC8uKpwFau4RPDYLuE3EXTp8N8G2vX2N7UC/+IXeNUnlWBGGcAG+Ig==", + "license": "MIT", + "dependencies": { + "@types/prismjs": "^1.26.0", + "clsx": "^2.0.0" + }, + "peerDependencies": { + "react": ">=16.0.0" + } + }, + "node_modules/prismjs": { + "version": "1.30.0", + "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.30.0.tgz", + "integrity": "sha512-DEvV2ZF2r2/63V+tK8hQvrR2ZGn10srHbXviTlcv7Kpzw8jWiNTqbVgjO3IY8RxrrOUF8VPMQQFysYYYv0YZxw==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/process-nextick-args": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", + "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", + "license": "MIT" + }, + "node_modules/prompts": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", + "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "license": "MIT", + "dependencies": { + "kleur": "^3.0.3", + "sisteransi": "^1.0.5" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "license": "MIT", + "dependencies": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, + "node_modules/property-information": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-7.1.0.tgz", + "integrity": "sha512-TwEZ+X+yCJmYfL7TPUOcvBZ4QfoT5YenQiJuX//0th53DE6w0xxLEtfK3iyryQFddXuvkIk51EEgrJQ0WJkOmQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/proto-list": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", + "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", + "license": "ISC" + }, + "node_modules/proxy-addr": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", + "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", + "license": "MIT", + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/proxy-addr/node_modules/ipaddr.js": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", + "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/pupa": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.3.0.tgz", + "integrity": "sha512-LjgDO2zPtoXP2wJpDjZrGdojii1uqO0cnwKoIoUzkfS98HDmbeiGmYiXo3lXeFlq2xvne1QFQhwYXSUCLKtEuA==", + "license": "MIT", + "dependencies": { + "escape-goat": "^4.0.0" + }, + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pvtsutils": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/pvtsutils/-/pvtsutils-1.3.6.tgz", + "integrity": "sha512-PLgQXQ6H2FWCaeRak8vvk1GW462lMxB5s3Jm673N82zI4vqtVUPuZdffdZbPDFRoU8kAhItWFtPCWiPpp4/EDg==", + "license": "MIT", + "dependencies": { + "tslib": "^2.8.1" + } + }, + "node_modules/pvutils": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/pvutils/-/pvutils-1.1.5.tgz", + "integrity": "sha512-KTqnxsgGiQ6ZAzZCVlJH5eOjSnvlyEgx1m8bkRJfOhmGRqfo5KLvmAlACQkrjEtOQ4B7wF9TdSLIs9O90MX9xA==", + "license": "MIT", + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/qs": { + "version": "6.14.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.2.tgz", + "integrity": "sha512-V/yCWTTF7VJ9hIh18Ugr2zhJMP01MY7c5kh4J870L7imm6/DIzBsNLTXzMwUA3yZ5b/KBqLx8Kp3uRvd7xSe3Q==", + "license": "BSD-3-Clause", + "dependencies": { + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/quick-lru": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz", + "integrity": "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/randombytes": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", + "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", + "license": "MIT", + "dependencies": { + "safe-buffer": "^5.1.0" + } + }, + "node_modules/range-parser": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz", + "integrity": "sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/raw-body": { + "version": "2.5.3", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.3.tgz", + "integrity": "sha512-s4VSOf6yN0rvbRZGxs8Om5CWj6seneMwK3oDb4lWDH0UPhWcxwOWw5+qk24bxq87szX1ydrwylIOp2uG1ojUpA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "http-errors": "~2.0.1", + "iconv-lite": "~0.4.24", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/raw-body/node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/raw-loader": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/raw-loader/-/raw-loader-4.0.2.tgz", + "integrity": "sha512-ZnScIV3ag9A4wPX/ZayxL/jZH+euYb6FcUinPcgiQW0+UBtEv0O6Q3lGd3cqJ+GHH+rksEv3Pj99oxJ3u3VIKA==", + "dev": true, + "license": "MIT", + "dependencies": { + "loader-utils": "^2.0.0", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/raw-loader/node_modules/ajv": { + "version": "6.15.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.15.0.tgz", + "integrity": "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/raw-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/raw-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true, + "license": "MIT" + }, + "node_modules/raw-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/rc": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", + "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", + "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", + "dependencies": { + "deep-extend": "^0.6.0", + "ini": "~1.3.0", + "minimist": "^1.2.0", + "strip-json-comments": "~2.0.1" + }, + "bin": { + "rc": "cli.js" + } + }, + "node_modules/rc/node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "license": "ISC" + }, + "node_modules/rc/node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react": { + "version": "19.2.4", + "resolved": "https://registry.npmjs.org/react/-/react-19.2.4.tgz", + "integrity": "sha512-9nfp2hYpCwOjAN+8TZFGhtWEwgvWHXqESH8qT89AT/lWklpLON22Lc8pEtnpsZz7VmawabSU0gCjnj8aC0euHQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react-dom": { + "version": "19.2.4", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.4.tgz", + "integrity": "sha512-AXJdLo8kgMbimY95O2aKQqsz2iWi9jMgKJhRBAxECE4IFxfcazB2LmzloIoibJI3C12IlY20+KFaLv+71bUJeQ==", + "license": "MIT", + "dependencies": { + "scheduler": "^0.27.0" + }, + "peerDependencies": { + "react": "^19.2.4" + } + }, + "node_modules/react-fast-compare": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/react-fast-compare/-/react-fast-compare-3.2.2.tgz", + "integrity": "sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ==", + "license": "MIT" + }, + "node_modules/react-helmet-async": { + "name": "@slorber/react-helmet-async", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz", + "integrity": "sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A==", + "license": "Apache-2.0", + "dependencies": { + "@babel/runtime": "^7.12.5", + "invariant": "^2.2.4", + "prop-types": "^15.7.2", + "react-fast-compare": "^3.2.0", + "shallowequal": "^1.1.0" + }, + "peerDependencies": { + "react": "^16.6.0 || ^17.0.0 || ^18.0.0 || ^19.0.0", + "react-dom": "^16.6.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" + } + }, + "node_modules/react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "license": "MIT" + }, + "node_modules/react-json-view-lite": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz", + "integrity": "sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0" + } + }, + "node_modules/react-loadable": { + "name": "@docusaurus/react-loadable", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", + "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", + "license": "MIT", + "dependencies": { + "@types/react": "*" + }, + "peerDependencies": { + "react": "*" + } + }, + "node_modules/react-loadable-ssr-addon-v5-slorber": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.3.tgz", + "integrity": "sha512-GXfh9VLwB5ERaCsU6RULh7tkemeX15aNh6wuMEBtfdyMa7fFG8TXrhXlx1SoEK2Ty/l6XIkzzYIQmyaWW3JgdQ==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.10.3" + }, + "engines": { + "node": ">=10.13.0" + }, + "peerDependencies": { + "react-loadable": "*", + "webpack": ">=4.41.1 || 5.x" + } + }, + "node_modules/react-router": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", + "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.12.13", + "history": "^4.9.0", + "hoist-non-react-statics": "^3.1.0", + "loose-envify": "^1.3.1", + "path-to-regexp": "^1.7.0", + "prop-types": "^15.6.2", + "react-is": "^16.6.0", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0" + }, + "peerDependencies": { + "react": ">=15" + } + }, + "node_modules/react-router-config": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/react-router-config/-/react-router-config-5.1.1.tgz", + "integrity": "sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.1.2" + }, + "peerDependencies": { + "react": ">=15", + "react-router": ">=5" + } + }, + "node_modules/react-router-dom": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-5.3.4.tgz", + "integrity": "sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.12.13", + "history": "^4.9.0", + "loose-envify": "^1.3.1", + "prop-types": "^15.6.2", + "react-router": "5.3.4", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0" + }, + "peerDependencies": { + "react": ">=15" + } + }, + "node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/readdirp": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", + "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "license": "MIT", + "dependencies": { + "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/recma-build-jsx": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-build-jsx/-/recma-build-jsx-1.0.0.tgz", + "integrity": "sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-util-build-jsx": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-jsx": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/recma-jsx/-/recma-jsx-1.0.1.tgz", + "integrity": "sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w==", + "license": "MIT", + "dependencies": { + "acorn-jsx": "^5.0.0", + "estree-util-to-js": "^2.0.0", + "recma-parse": "^1.0.0", + "recma-stringify": "^1.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + }, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/recma-parse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-parse/-/recma-parse-1.0.0.tgz", + "integrity": "sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "esast-util-from-js": "^2.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-stringify": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-stringify/-/recma-stringify-1.0.0.tgz", + "integrity": "sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-util-to-js": "^2.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/reflect-metadata": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz", + "integrity": "sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q==", + "license": "Apache-2.0" + }, + "node_modules/regenerate": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", + "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", + "license": "MIT" + }, + "node_modules/regenerate-unicode-properties": { + "version": "10.2.2", + "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz", + "integrity": "sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g==", + "license": "MIT", + "dependencies": { + "regenerate": "^1.4.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/regexpu-core": { + "version": "6.4.0", + "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.4.0.tgz", + "integrity": "sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA==", + "license": "MIT", + "dependencies": { + "regenerate": "^1.4.2", + "regenerate-unicode-properties": "^10.2.2", + "regjsgen": "^0.8.0", + "regjsparser": "^0.13.0", + "unicode-match-property-ecmascript": "^2.0.0", + "unicode-match-property-value-ecmascript": "^2.2.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/registry-auth-token": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.1.1.tgz", + "integrity": "sha512-P7B4+jq8DeD2nMsAcdfaqHbssgHtZ7Z5+++a5ask90fvmJ8p5je4mOa+wzu+DB4vQ5tdJV/xywY+UnVFeQLV5Q==", + "license": "MIT", + "dependencies": { + "@pnpm/npm-conf": "^3.0.2" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/registry-url": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", + "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", + "license": "MIT", + "dependencies": { + "rc": "1.2.8" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/regjsgen": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/regjsgen/-/regjsgen-0.8.0.tgz", + "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==", + "license": "MIT" + }, + "node_modules/regjsparser": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.0.tgz", + "integrity": "sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q==", + "license": "BSD-2-Clause", + "dependencies": { + "jsesc": "~3.1.0" + }, + "bin": { + "regjsparser": "bin/parser" + } + }, + "node_modules/rehype-raw": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/rehype-raw/-/rehype-raw-7.0.0.tgz", + "integrity": "sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-raw": "^9.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-recma": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/rehype-recma/-/rehype-recma-1.0.0.tgz", + "integrity": "sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "hast-util-to-estree": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/relateurl": { + "version": "0.2.7", + "resolved": "https://registry.npmjs.org/relateurl/-/relateurl-0.2.7.tgz", + "integrity": "sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog==", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/remark-directive": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/remark-directive/-/remark-directive-3.0.1.tgz", + "integrity": "sha512-gwglrEQEZcZYgVyG1tQuA+h58EZfq5CSULw7J90AFuCTyib1thgHPoqQ+h9iFvU6R+vnZ5oNFQR5QKgGpk741A==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-directive": "^3.0.0", + "micromark-extension-directive": "^3.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-emoji": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/remark-emoji/-/remark-emoji-4.0.1.tgz", + "integrity": "sha512-fHdvsTR1dHkWKev9eNyhTo4EFwbUvJ8ka9SgeWkMPYFX4WoI7ViVBms3PjlQYgw5TLvNQso3GUB/b/8t3yo+dg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.2", + "emoticon": "^4.0.1", + "mdast-util-find-and-replace": "^3.0.1", + "node-emoji": "^2.1.0", + "unified": "^11.0.4" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + } + }, + "node_modules/remark-frontmatter": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-5.0.0.tgz", + "integrity": "sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-frontmatter": "^2.0.0", + "micromark-extension-frontmatter": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-gfm": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/remark-gfm/-/remark-gfm-4.0.1.tgz", + "integrity": "sha512-1quofZ2RQ9EWdeN34S79+KExV1764+wCUGop5CPL1WGdD0ocPpu91lzPGbwWMECpEpd42kJGQwzRfyov9j4yNg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-gfm": "^3.0.0", + "micromark-extension-gfm": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-stringify": "^11.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-mdx": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/remark-mdx/-/remark-mdx-3.1.1.tgz", + "integrity": "sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg==", + "license": "MIT", + "dependencies": { + "mdast-util-mdx": "^3.0.0", + "micromark-extension-mdxjs": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-parse": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-11.0.0.tgz", + "integrity": "sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-rehype": { + "version": "11.1.2", + "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-11.1.2.tgz", + "integrity": "sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "mdast-util-to-hast": "^13.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-stringify": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-11.0.0.tgz", + "integrity": "sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-to-markdown": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/renderkid": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/renderkid/-/renderkid-3.0.0.tgz", + "integrity": "sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg==", + "license": "MIT", + "dependencies": { + "css-select": "^4.1.3", + "dom-converter": "^0.2.0", + "htmlparser2": "^6.1.0", + "lodash": "^4.17.21", + "strip-ansi": "^6.0.1" + } + }, + "node_modules/renderkid/node_modules/css-select": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-4.3.0.tgz", + "integrity": "sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.0.1", + "domhandler": "^4.3.1", + "domutils": "^2.8.0", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/renderkid/node_modules/dom-serializer": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.4.1.tgz", + "integrity": "sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==", + "license": "MIT", + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.2.0", + "entities": "^2.0.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/domhandler": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.3.1.tgz", + "integrity": "sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==", + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.2.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/domutils": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", + "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^1.0.1", + "domelementtype": "^2.2.0", + "domhandler": "^4.2.0" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/entities": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", + "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", + "license": "BSD-2-Clause", + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/htmlparser2": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz", + "integrity": "sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.0.0", + "domutils": "^2.5.2", + "entities": "^2.0.0" + } + }, + "node_modules/repeat-string": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", + "integrity": "sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==", + "license": "MIT", + "engines": { + "node": ">=0.10" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-like": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/require-like/-/require-like-0.1.2.tgz", + "integrity": "sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A==", + "engines": { + "node": "*" + } + }, + "node_modules/requires-port": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", + "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", + "license": "MIT" + }, + "node_modules/resolve": { + "version": "1.22.11", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", + "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", + "license": "MIT", + "dependencies": { + "is-core-module": "^2.16.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-alpn": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", + "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==", + "license": "MIT" + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/resolve-pathname": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz", + "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==", + "license": "MIT" + }, + "node_modules/responselike": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/responselike/-/responselike-3.0.0.tgz", + "integrity": "sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg==", + "license": "MIT", + "dependencies": { + "lowercase-keys": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/retry": { + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", + "integrity": "sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rtlcss": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/rtlcss/-/rtlcss-4.3.0.tgz", + "integrity": "sha512-FI+pHEn7Wc4NqKXMXFM+VAYKEj/mRIcW4h24YVwVtyjI+EqGrLc2Hx/Ny0lrZ21cBWU2goLy36eqMcNj3AQJig==", + "license": "MIT", + "dependencies": { + "escalade": "^3.1.1", + "picocolors": "^1.0.0", + "postcss": "^8.4.21", + "strip-json-comments": "^3.1.1" + }, + "bin": { + "rtlcss": "bin/rtlcss.js" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/run-applescript": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/run-applescript/-/run-applescript-7.1.0.tgz", + "integrity": "sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "license": "MIT" + }, + "node_modules/sax": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.6.0.tgz", + "integrity": "sha512-6R3J5M4AcbtLUdZmRv2SygeVaM7IhrLXu9BmnOGmmACak8fiUtOsYNWUS4uK7upbmHIBbLBeFeI//477BKLBzA==", + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=11.0.0" + } + }, + "node_modules/scheduler": { + "version": "0.27.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.27.0.tgz", + "integrity": "sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q==", + "license": "MIT" + }, + "node_modules/schema-dts": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/schema-dts/-/schema-dts-1.1.5.tgz", + "integrity": "sha512-RJr9EaCmsLzBX2NDiO5Z3ux2BVosNZN5jo0gWgsyKvxKIUL5R3swNvoorulAeL9kLB0iTSX7V6aokhla2m7xbg==", + "license": "Apache-2.0" + }, + "node_modules/schema-utils": { + "version": "4.3.3", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-4.3.3.tgz", + "integrity": "sha512-eflK8wEtyOE6+hsaRVPxvUKYCpRgzLqDTb8krvAsRIwOGlHoSgYLgBXoubGgLd2fT41/OUYdb48v4k4WWHQurA==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.9", + "ajv": "^8.9.0", + "ajv-formats": "^2.1.1", + "ajv-keywords": "^5.1.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/search-insights": { + "version": "2.17.3", + "resolved": "https://registry.npmjs.org/search-insights/-/search-insights-2.17.3.tgz", + "integrity": "sha512-RQPdCYTa8A68uM2jwxoY842xDhvx3E5LFL1LxvxCNMev4o5mLuokczhzjAgGwUZBAmOKZknArSxLKmXtIi2AxQ==", + "license": "MIT", + "peer": true + }, + "node_modules/section-matter": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz", + "integrity": "sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==", + "license": "MIT", + "dependencies": { + "extend-shallow": "^2.0.1", + "kind-of": "^6.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/select-hose": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/select-hose/-/select-hose-2.0.0.tgz", + "integrity": "sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg==", + "license": "MIT" + }, + "node_modules/selfsigned": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/selfsigned/-/selfsigned-5.5.0.tgz", + "integrity": "sha512-ftnu3TW4+3eBfLRFnDEkzGxSF/10BJBkaLJuBHZX0kiPS7bRdlpZGu6YGt4KngMkdTwJE6MbjavFpqHvqVt+Ew==", + "license": "MIT", + "dependencies": { + "@peculiar/x509": "^1.14.2", + "pkijs": "^3.3.3" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/semver": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", + "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver-diff": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", + "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", + "license": "MIT", + "dependencies": { + "semver": "^7.3.5" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/send": { + "version": "0.19.2", + "resolved": "https://registry.npmjs.org/send/-/send-0.19.2.tgz", + "integrity": "sha512-VMbMxbDeehAxpOtWJXlcUS5E8iXh6QmN+BkRX1GARS3wRaXEEgzCcB10gTQazO42tpNIya8xIyNx8fll1OFPrg==", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "~0.5.2", + "http-errors": "~2.0.1", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "~2.4.1", + "range-parser": "~1.2.1", + "statuses": "~2.0.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/send/node_modules/debug/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/send/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serialize-javascript": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", + "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", + "license": "BSD-3-Clause", + "dependencies": { + "randombytes": "^2.1.0" + } + }, + "node_modules/serve-handler": { + "version": "6.1.7", + "resolved": "https://registry.npmjs.org/serve-handler/-/serve-handler-6.1.7.tgz", + "integrity": "sha512-CinAq1xWb0vR3twAv9evEU8cNWkXCb9kd5ePAHUKJBkOsUpR1wt/CvGdeca7vqumL1U5cSaeVQ6zZMxiJ3yWsg==", + "license": "MIT", + "dependencies": { + "bytes": "3.0.0", + "content-disposition": "0.5.2", + "mime-types": "2.1.18", + "minimatch": "3.1.5", + "path-is-inside": "1.0.2", + "path-to-regexp": "3.3.0", + "range-parser": "1.2.0" + } + }, + "node_modules/serve-handler/node_modules/path-to-regexp": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-3.3.0.tgz", + "integrity": "sha512-qyCH421YQPS2WFDxDjftfc1ZR5WKQzVzqsp4n9M2kQhVOo/ByahFoUNJfl58kOcEGfQ//7weFTDhm+ss8Ecxgw==", + "license": "MIT" + }, + "node_modules/serve-index": { + "version": "1.9.2", + "resolved": "https://registry.npmjs.org/serve-index/-/serve-index-1.9.2.tgz", + "integrity": "sha512-KDj11HScOaLmrPxl70KYNW1PksP4Nb/CLL2yvC+Qd2kHMPEEpfc4Re2e4FOay+bC/+XQl/7zAcWON3JVo5v3KQ==", + "license": "MIT", + "dependencies": { + "accepts": "~1.3.8", + "batch": "0.6.1", + "debug": "2.6.9", + "escape-html": "~1.0.3", + "http-errors": "~1.8.0", + "mime-types": "~2.1.35", + "parseurl": "~1.3.3" + }, + "engines": { + "node": ">= 0.8.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/serve-index/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/serve-index/node_modules/depd": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", + "integrity": "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/http-errors": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.8.1.tgz", + "integrity": "sha512-Kpk9Sm7NmI+RHhnj6OIWDI1d6fIoFAtFt9RLaTMRlg/8w49juAStsrBgp0Dp4OdxdVbRIeKhtCUvoi/RuAhO4g==", + "license": "MIT", + "dependencies": { + "depd": "~1.1.2", + "inherits": "2.0.4", + "setprototypeof": "1.2.0", + "statuses": ">= 1.5.0 < 2", + "toidentifier": "1.0.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/serve-index/node_modules/statuses": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", + "integrity": "sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-static": { + "version": "1.16.3", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.3.tgz", + "integrity": "sha512-x0RTqQel6g5SY7Lg6ZreMmsOzncHFU7nhnRWkKgWuMTu5NN0DR5oruckMqRvacAN9d5w6ARnRBXl9xhDCgfMeA==", + "license": "MIT", + "dependencies": { + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "~0.19.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", + "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", + "license": "ISC" + }, + "node_modules/shallow-clone": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", + "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", + "license": "MIT", + "dependencies": { + "kind-of": "^6.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shallowequal": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz", + "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==", + "license": "MIT" + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "license": "MIT", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/shell-quote": { + "version": "1.8.3", + "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.3.tgz", + "integrity": "sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", + "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "license": "ISC" + }, + "node_modules/sirv": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/sirv/-/sirv-2.0.4.tgz", + "integrity": "sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==", + "license": "MIT", + "dependencies": { + "@polka/url": "^1.0.0-next.24", + "mrmime": "^2.0.0", + "totalist": "^3.0.0" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/sisteransi": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", + "license": "MIT" + }, + "node_modules/sitemap": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/sitemap/-/sitemap-7.1.3.tgz", + "integrity": "sha512-tAjEd+wt/YwnEbfNB2ht51ybBJxbEWwe5ki/Z//Wh0rpBFTCUSj46GnxUKEWzhfuJTsee8x3lybHxFgUMig2hw==", + "license": "MIT", + "dependencies": { + "@types/node": "^17.0.5", + "@types/sax": "^1.2.1", + "arg": "^5.0.0", + "sax": "^1.2.4" + }, + "bin": { + "sitemap": "dist/cli.js" + }, + "engines": { + "node": ">=12.0.0", + "npm": ">=5.6.0" + } + }, + "node_modules/sitemap/node_modules/@types/node": { + "version": "17.0.45", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.45.tgz", + "integrity": "sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==", + "license": "MIT" + }, + "node_modules/skin-tone": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/skin-tone/-/skin-tone-2.0.0.tgz", + "integrity": "sha512-kUMbT1oBJCpgrnKoSr0o6wPtvRWT9W9UKvGLwfJYO2WuahZRHOpEyL1ckyMGgMWh0UdpmaoFqKKD29WTomNEGA==", + "license": "MIT", + "dependencies": { + "unicode-emoji-modifier-base": "^1.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/snake-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", + "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", + "license": "MIT", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/sockjs": { + "version": "0.3.24", + "resolved": "https://registry.npmjs.org/sockjs/-/sockjs-0.3.24.tgz", + "integrity": "sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ==", + "license": "MIT", + "dependencies": { + "faye-websocket": "^0.11.3", + "uuid": "^8.3.2", + "websocket-driver": "^0.7.4" + } + }, + "node_modules/sort-css-media-queries": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/sort-css-media-queries/-/sort-css-media-queries-2.2.0.tgz", + "integrity": "sha512-0xtkGhWCC9MGt/EzgnvbbbKhqWjl1+/rncmhTh5qCpbYguXh6S/qwePfv/JQ8jePXXmqingylxoC49pCkSPIbA==", + "license": "MIT", + "engines": { + "node": ">= 6.3.0" + } + }, + "node_modules/source-map": { + "version": "0.7.6", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", + "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", + "license": "BSD-3-Clause", + "engines": { + "node": ">= 12" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.21", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", + "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "license": "MIT", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/source-map-support/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/space-separated-tokens": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", + "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/spdy": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/spdy/-/spdy-4.0.2.tgz", + "integrity": "sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA==", + "license": "MIT", + "dependencies": { + "debug": "^4.1.0", + "handle-thing": "^2.0.0", + "http-deceiver": "^1.2.7", + "select-hose": "^2.0.0", + "spdy-transport": "^3.0.0" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/spdy-transport": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/spdy-transport/-/spdy-transport-3.0.0.tgz", + "integrity": "sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw==", + "license": "MIT", + "dependencies": { + "debug": "^4.1.0", + "detect-node": "^2.0.4", + "hpack.js": "^2.1.6", + "obuf": "^1.1.2", + "readable-stream": "^3.0.6", + "wbuf": "^1.7.3" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "license": "BSD-3-Clause" + }, + "node_modules/srcset": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/srcset/-/srcset-4.0.0.tgz", + "integrity": "sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/statuses": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", + "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/std-env": { + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", + "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "license": "MIT" + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "license": "MIT", + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/string-width/node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/string-width/node_modules/strip-ansi": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.2.2" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/stringify-entities": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", + "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", + "license": "MIT", + "dependencies": { + "character-entities-html4": "^2.0.0", + "character-entities-legacy": "^3.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/stringify-object": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", + "integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==", + "license": "BSD-2-Clause", + "dependencies": { + "get-own-enumerable-property-symbols": "^3.0.0", + "is-obj": "^1.0.1", + "is-regexp": "^1.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/strip-bom-string/-/strip-bom-string-1.0.0.tgz", + "integrity": "sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/style-to-js": { + "version": "1.1.21", + "resolved": "https://registry.npmjs.org/style-to-js/-/style-to-js-1.1.21.tgz", + "integrity": "sha512-RjQetxJrrUJLQPHbLku6U/ocGtzyjbJMP9lCNK7Ag0CNh690nSH8woqWH9u16nMjYBAok+i7JO1NP2pOy8IsPQ==", + "license": "MIT", + "dependencies": { + "style-to-object": "1.0.14" + } + }, + "node_modules/style-to-object": { + "version": "1.0.14", + "resolved": "https://registry.npmjs.org/style-to-object/-/style-to-object-1.0.14.tgz", + "integrity": "sha512-LIN7rULI0jBscWQYaSswptyderlarFkjQ+t79nzty8tcIAceVomEVlLzH5VP4Cmsv6MtKhs7qaAiwlcp+Mgaxw==", + "license": "MIT", + "dependencies": { + "inline-style-parser": "0.2.7" + } + }, + "node_modules/stylehacks": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-6.1.1.tgz", + "integrity": "sha512-gSTTEQ670cJNoaeIp9KX6lZmm8LJ3jPB5yJmX8Zq/wQxOsAFXV3qjWzHas3YYk1qesuVIyYWWUpZ0vSE/dTSGg==", + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/svg-parser": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/svg-parser/-/svg-parser-2.0.4.tgz", + "integrity": "sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ==", + "license": "MIT" + }, + "node_modules/svgo": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/svgo/-/svgo-3.3.3.tgz", + "integrity": "sha512-+wn7I4p7YgJhHs38k2TNjy1vCfPIfLIJWR5MnCStsN8WuuTcBnRKcMHQLMM2ijxGZmDoZwNv8ipl5aTTen62ng==", + "license": "MIT", + "dependencies": { + "commander": "^7.2.0", + "css-select": "^5.1.0", + "css-tree": "^2.3.1", + "css-what": "^6.1.0", + "csso": "^5.0.5", + "picocolors": "^1.0.0", + "sax": "^1.5.0" + }, + "bin": { + "svgo": "bin/svgo" + }, + "engines": { + "node": ">=14.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/svgo" + } + }, + "node_modules/svgo/node_modules/commander": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", + "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, + "node_modules/tapable": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.3.2.tgz", + "integrity": "sha512-1MOpMXuhGzGL5TTCZFItxCc0AARf1EZFQkGqMm7ERKj8+Hgr5oLvJOVFcC+lRmR8hCe2S3jC4T5D7Vg/d7/fhA==", + "license": "MIT", + "engines": { + "node": ">=6" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/terser": { + "version": "5.46.1", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.46.1.tgz", + "integrity": "sha512-vzCjQO/rgUuK9sf8VJZvjqiqiHFaZLnOiimmUuOKODxWL8mm/xua7viT7aqX7dgPY60otQjUotzFMmCB4VdmqQ==", + "license": "BSD-2-Clause", + "dependencies": { + "@jridgewell/source-map": "^0.3.3", + "acorn": "^8.15.0", + "commander": "^2.20.0", + "source-map-support": "~0.5.20" + }, + "bin": { + "terser": "bin/terser" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/terser-webpack-plugin": { + "version": "5.4.0", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.4.0.tgz", + "integrity": "sha512-Bn5vxm48flOIfkdl5CaD2+1CiUVbonWQ3KQPyP7/EuIl9Gbzq/gQFOzaMFUEgVjB1396tcK0SG8XcNJ/2kDH8g==", + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.25", + "jest-worker": "^27.4.5", + "schema-utils": "^4.3.0", + "terser": "^5.31.1" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "esbuild": { + "optional": true + }, + "uglify-js": { + "optional": true + } + } + }, + "node_modules/terser-webpack-plugin/node_modules/jest-worker": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", + "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", + "license": "MIT", + "dependencies": { + "@types/node": "*", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/terser-webpack-plugin/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/terser/node_modules/commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "license": "MIT" + }, + "node_modules/thingies": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/thingies/-/thingies-2.6.0.tgz", + "integrity": "sha512-rMHRjmlFLM1R96UYPvpmnc3LYtdFrT33JIB7L9hetGue1qAPfn1N2LJeEjxUSidu1Iku+haLZXDuEXUHNGO/lg==", + "license": "MIT", + "engines": { + "node": ">=10.18" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "^2" + } + }, + "node_modules/thunky": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/thunky/-/thunky-1.1.0.tgz", + "integrity": "sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA==", + "license": "MIT" + }, + "node_modules/tiny-invariant": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.3.tgz", + "integrity": "sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==", + "license": "MIT" + }, + "node_modules/tiny-warning": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", + "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==", + "license": "MIT" + }, + "node_modules/tinypool": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", + "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", + "license": "MIT", + "engines": { + "node": "^18.0.0 || >=20.0.0" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/toidentifier": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", + "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", + "license": "MIT", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/totalist": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/totalist/-/totalist-3.0.1.tgz", + "integrity": "sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/tree-dump": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/tree-dump/-/tree-dump-1.1.0.tgz", + "integrity": "sha512-rMuvhU4MCDbcbnleZTFezWsaZXRFemSqAM+7jPnzUl1fo9w3YEKOxAeui0fz3OI4EU4hf23iyA7uQRVko+UaBA==", + "license": "Apache-2.0", + "engines": { + "node": ">=10.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/streamich" + }, + "peerDependencies": { + "tslib": "2" + } + }, + "node_modules/trim-lines": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", + "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/trough": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/trough/-/trough-2.2.0.tgz", + "integrity": "sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, + "node_modules/tsyringe": { + "version": "4.10.0", + "resolved": "https://registry.npmjs.org/tsyringe/-/tsyringe-4.10.0.tgz", + "integrity": "sha512-axr3IdNuVIxnaK5XGEUFTu3YmAQ6lllgrvqfEoR16g/HGnYY/6We4oWENtAnzK6/LpJ2ur9PAb80RBt7/U4ugw==", + "license": "MIT", + "dependencies": { + "tslib": "^1.9.3" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/tsyringe/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "license": "0BSD" + }, + "node_modules/type-fest": { + "version": "2.19.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz", + "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "license": "MIT", + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/typedarray-to-buffer": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", + "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", + "license": "MIT", + "dependencies": { + "is-typedarray": "^1.0.0" + } + }, + "node_modules/typedoc": { + "version": "0.28.18", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.18.tgz", + "integrity": "sha512-NTWTUOFRQ9+SGKKTuWKUioUkjxNwtS3JDRPVKZAXGHZy2wCA8bdv2iJiyeePn0xkmK+TCCqZFT0X7+2+FLjngA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@gerrit0/mini-shiki": "^3.23.0", + "lunr": "^2.3.9", + "markdown-it": "^14.1.1", + "minimatch": "^10.2.4", + "yaml": "^2.8.2" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 18", + "pnpm": ">= 10" + }, + "peerDependencies": { + "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x || 6.0.x" + } + }, + "node_modules/typedoc-docusaurus-theme": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/typedoc-docusaurus-theme/-/typedoc-docusaurus-theme-1.4.2.tgz", + "integrity": "sha512-i9YYDcScLD0WUiX8I+LXHX3ZVvRDlJsmRo9l/uWrFT37cHlMz4Ay0GOnWzHUBnnwAo1uzYOw9RjUXznbWozBEA==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "typedoc-plugin-markdown": ">=4.8.0" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "4.11.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.11.0.tgz", + "integrity": "sha512-2iunh2ALyfyh204OF7h2u0kuQ84xB3jFZtFyUr01nThJkLvR8oGGSSDlyt2gyO4kXhvUxDcVbO0y43+qX+wFbw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typedoc": "0.28.x" + } + }, + "node_modules/typedoc/node_modules/balanced-match": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", + "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz", + "integrity": "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^4.0.2" + }, + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "10.2.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.4.tgz", + "integrity": "sha512-oRjTw/97aTBN0RHbYCdtF1MQfvusSIBQM0IZEgzl6426+8jSC0nF1a/GmnVLpfB9yyr6g6FTqWqiZVbxrtaCIg==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "brace-expansion": "^5.0.2" + }, + "engines": { + "node": "18 || 20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/typescript": { + "version": "5.6.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", + "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", + "devOptional": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true, + "license": "MIT" + }, + "node_modules/undici": { + "version": "7.24.6", + "resolved": "https://registry.npmjs.org/undici/-/undici-7.24.6.tgz", + "integrity": "sha512-Xi4agocCbRzt0yYMZGMA6ApD7gvtUFaxm4ZmeacWI4cZxaF6C+8I8QfofC20NAePiB/IcvZmzkJ7XPa471AEtA==", + "license": "MIT", + "engines": { + "node": ">=20.18.1" + } + }, + "node_modules/undici-types": { + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", + "integrity": "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w==", + "license": "MIT" + }, + "node_modules/unicode-canonical-property-names-ecmascript": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz", + "integrity": "sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-emoji-modifier-base": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unicode-emoji-modifier-base/-/unicode-emoji-modifier-base-1.0.0.tgz", + "integrity": "sha512-yLSH4py7oFH3oG/9K+XWrz1pSi3dfUrWEnInbxMfArOfc1+33BlGPQtLsOYwvdMy11AwUBetYuaRxSPqgkq+8g==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-ecmascript": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", + "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", + "license": "MIT", + "dependencies": { + "unicode-canonical-property-names-ecmascript": "^2.0.0", + "unicode-property-aliases-ecmascript": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-value-ecmascript": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz", + "integrity": "sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-property-aliases-ecmascript": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz", + "integrity": "sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unified": { + "version": "11.0.5", + "resolved": "https://registry.npmjs.org/unified/-/unified-11.0.5.tgz", + "integrity": "sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "bail": "^2.0.0", + "devlop": "^1.0.0", + "extend": "^3.0.0", + "is-plain-obj": "^4.0.0", + "trough": "^2.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unique-string": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", + "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", + "license": "MIT", + "dependencies": { + "crypto-random-string": "^4.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/unist-util-is": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.1.tgz", + "integrity": "sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", + "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position-from-estree/-/unist-util-position-from-estree-2.0.0.tgz", + "integrity": "sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-stringify-position": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", + "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.1.0.tgz", + "integrity": "sha512-m+vIdyeCOpdr/QeQCu2EzxX/ohgS8KbnPDgFni4dQsfSCtpz8UqDyY5GjRru8PDKuYn7Fq19j1CQ+nJSsGKOzg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-parents": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.2.tgz", + "integrity": "sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/update-browserslist-db": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", + "integrity": "sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "escalade": "^3.2.0", + "picocolors": "^1.1.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/update-notifier": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", + "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", + "license": "BSD-2-Clause", + "dependencies": { + "boxen": "^7.0.0", + "chalk": "^5.0.1", + "configstore": "^6.0.0", + "has-yarn": "^3.0.0", + "import-lazy": "^4.0.0", + "is-ci": "^3.0.1", + "is-installed-globally": "^0.4.0", + "is-npm": "^6.0.0", + "is-yarn-global": "^0.4.0", + "latest-version": "^7.0.0", + "pupa": "^3.1.0", + "semver": "^7.3.7", + "semver-diff": "^4.0.0", + "xdg-basedir": "^5.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/yeoman/update-notifier?sponsor=1" + } + }, + "node_modules/update-notifier/node_modules/boxen": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.1.1.tgz", + "integrity": "sha512-2hCgjEmP8YLWQ130n2FerGv7rYpfBmnmp9Uy2Le1vge6X3gZIfSmEzP5QTDElFxcvVcXlEn8Aq6MU/PZygIOog==", + "license": "MIT", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^7.0.1", + "chalk": "^5.2.0", + "cli-boxes": "^3.0.0", + "string-width": "^5.1.2", + "type-fest": "^2.13.0", + "widest-line": "^4.0.1", + "wrap-ansi": "^8.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/update-notifier/node_modules/camelcase": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.1.tgz", + "integrity": "sha512-xlx1yCK2Oc1APsPXDL2LdlNP6+uu8OCDdhOBSVT279M/S+y75O30C2VuD8T2ogdePBBl7PfPF4504tnLgX3zfw==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/update-notifier/node_modules/chalk": { + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", + "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", + "license": "MIT", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "license": "BSD-2-Clause", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/url-loader": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/url-loader/-/url-loader-4.1.1.tgz", + "integrity": "sha512-3BTV812+AVHHOJQO8O5MkWgZ5aosP7GnROJwvzLS9hWDj00lZ6Z0wNak423Lp9PBZN05N+Jk/N5Si8jRAlGyWA==", + "license": "MIT", + "dependencies": { + "loader-utils": "^2.0.0", + "mime-types": "^2.1.27", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "file-loader": "*", + "webpack": "^4.0.0 || ^5.0.0" + }, + "peerDependenciesMeta": { + "file-loader": { + "optional": true + } + } + }, + "node_modules/url-loader/node_modules/ajv": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", + "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/url-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "license": "MIT", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/url-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "license": "MIT" + }, + "node_modules/url-loader/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/url-loader/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/url-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "license": "MIT" + }, + "node_modules/utila": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/utila/-/utila-0.4.0.tgz", + "integrity": "sha512-Z0DbgELS9/L/75wZbro8xAnT50pBVFQZ+hUEueGDU5FN51YSCYM+jdxsfCiHjwNP/4LCDD0i/graKpeBnOXKRA==", + "license": "MIT" + }, + "node_modules/utility-types": { + "version": "3.11.0", + "resolved": "https://registry.npmjs.org/utility-types/-/utility-types-3.11.0.tgz", + "integrity": "sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw==", + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", + "license": "MIT", + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/uuid": { + "version": "8.3.2", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", + "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", + "license": "MIT", + "bin": { + "uuid": "dist/bin/uuid" + } + }, + "node_modules/value-equal": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/value-equal/-/value-equal-1.0.1.tgz", + "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==", + "license": "MIT" + }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/vfile": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", + "integrity": "sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-location": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-5.0.3.tgz", + "integrity": "sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-message": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.3.tgz", + "integrity": "sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/watchpack": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.5.1.tgz", + "integrity": "sha512-Zn5uXdcFNIA1+1Ei5McRd+iRzfhENPCe7LeABkJtNulSxjma+l7ltNx55BWZkRlwRnpOgHqxnjyaDgJnNXnqzg==", + "license": "MIT", + "dependencies": { + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.1.2" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/wbuf": { + "version": "1.7.3", + "resolved": "https://registry.npmjs.org/wbuf/-/wbuf-1.7.3.tgz", + "integrity": "sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA==", + "license": "MIT", + "dependencies": { + "minimalistic-assert": "^1.0.0" + } + }, + "node_modules/web-namespaces": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/web-namespaces/-/web-namespaces-2.0.1.tgz", + "integrity": "sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/webpack": { + "version": "5.105.4", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.105.4.tgz", + "integrity": "sha512-jTywjboN9aHxFlToqb0K0Zs9SbBoW4zRUlGzI2tYNxVYcEi/IPpn+Xi4ye5jTLvX2YeLuic/IvxNot+Q1jMoOw==", + "license": "MIT", + "dependencies": { + "@types/eslint-scope": "^3.7.7", + "@types/estree": "^1.0.8", + "@types/json-schema": "^7.0.15", + "@webassemblyjs/ast": "^1.14.1", + "@webassemblyjs/wasm-edit": "^1.14.1", + "@webassemblyjs/wasm-parser": "^1.14.1", + "acorn": "^8.16.0", + "acorn-import-phases": "^1.0.3", + "browserslist": "^4.28.1", + "chrome-trace-event": "^1.0.2", + "enhanced-resolve": "^5.20.0", + "es-module-lexer": "^2.0.0", + "eslint-scope": "5.1.1", + "events": "^3.2.0", + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.2.11", + "json-parse-even-better-errors": "^2.3.1", + "loader-runner": "^4.3.1", + "mime-types": "^2.1.27", + "neo-async": "^2.6.2", + "schema-utils": "^4.3.3", + "tapable": "^2.3.0", + "terser-webpack-plugin": "^5.3.17", + "watchpack": "^2.5.1", + "webpack-sources": "^3.3.4" + }, + "bin": { + "webpack": "bin/webpack.js" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependenciesMeta": { + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-bundle-analyzer": { + "version": "4.10.2", + "resolved": "https://registry.npmjs.org/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.2.tgz", + "integrity": "sha512-vJptkMm9pk5si4Bv922ZbKLV8UTT4zib4FPgXMhgzUny0bfDDkLXAVQs3ly3fS4/TN9ROFtb0NFrm04UXFE/Vw==", + "license": "MIT", + "dependencies": { + "@discoveryjs/json-ext": "0.5.7", + "acorn": "^8.0.4", + "acorn-walk": "^8.0.0", + "commander": "^7.2.0", + "debounce": "^1.2.1", + "escape-string-regexp": "^4.0.0", + "gzip-size": "^6.0.0", + "html-escaper": "^2.0.2", + "opener": "^1.5.2", + "picocolors": "^1.0.0", + "sirv": "^2.0.3", + "ws": "^7.3.1" + }, + "bin": { + "webpack-bundle-analyzer": "lib/bin/analyzer.js" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/webpack-bundle-analyzer/node_modules/commander": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", + "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, + "node_modules/webpack-dev-middleware": { + "version": "7.4.5", + "resolved": "https://registry.npmjs.org/webpack-dev-middleware/-/webpack-dev-middleware-7.4.5.tgz", + "integrity": "sha512-uxQ6YqGdE4hgDKNf7hUiPXOdtkXvBJXrfEGYSx7P7LC8hnUYGK70X6xQXUvXeNyBDDcsiQXpG2m3G9vxowaEuA==", + "license": "MIT", + "dependencies": { + "colorette": "^2.0.10", + "memfs": "^4.43.1", + "mime-types": "^3.0.1", + "on-finished": "^2.4.1", + "range-parser": "^1.2.1", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 18.12.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + } + } + }, + "node_modules/webpack-dev-middleware/node_modules/mime-db": { + "version": "1.54.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", + "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack-dev-middleware/node_modules/mime-types": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.2.tgz", + "integrity": "sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A==", + "license": "MIT", + "dependencies": { + "mime-db": "^1.54.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/webpack-dev-middleware/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack-dev-server": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-5.2.3.tgz", + "integrity": "sha512-9Gyu2F7+bg4Vv+pjbovuYDhHX+mqdqITykfzdM9UyKqKHlsE5aAjRhR+oOEfXW5vBeu8tarzlJFIZva4ZjAdrQ==", + "license": "MIT", + "dependencies": { + "@types/bonjour": "^3.5.13", + "@types/connect-history-api-fallback": "^1.5.4", + "@types/express": "^4.17.25", + "@types/express-serve-static-core": "^4.17.21", + "@types/serve-index": "^1.9.4", + "@types/serve-static": "^1.15.5", + "@types/sockjs": "^0.3.36", + "@types/ws": "^8.5.10", + "ansi-html-community": "^0.0.8", + "bonjour-service": "^1.2.1", + "chokidar": "^3.6.0", + "colorette": "^2.0.10", + "compression": "^1.8.1", + "connect-history-api-fallback": "^2.0.0", + "express": "^4.22.1", + "graceful-fs": "^4.2.6", + "http-proxy-middleware": "^2.0.9", + "ipaddr.js": "^2.1.0", + "launch-editor": "^2.6.1", + "open": "^10.0.3", + "p-retry": "^6.2.0", + "schema-utils": "^4.2.0", + "selfsigned": "^5.5.0", + "serve-index": "^1.9.1", + "sockjs": "^0.3.24", + "spdy": "^4.0.2", + "webpack-dev-middleware": "^7.4.2", + "ws": "^8.18.0" + }, + "bin": { + "webpack-dev-server": "bin/webpack-dev-server.js" + }, + "engines": { + "node": ">= 18.12.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + }, + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-dev-server/node_modules/define-lazy-prop": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz", + "integrity": "sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/webpack-dev-server/node_modules/open": { + "version": "10.2.0", + "resolved": "https://registry.npmjs.org/open/-/open-10.2.0.tgz", + "integrity": "sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA==", + "license": "MIT", + "dependencies": { + "default-browser": "^5.2.1", + "define-lazy-prop": "^3.0.0", + "is-inside-container": "^1.0.0", + "wsl-utils": "^0.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/webpack-dev-server/node_modules/ws": { + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.20.0.tgz", + "integrity": "sha512-sAt8BhgNbzCtgGbt2OxmpuryO63ZoDk/sqaB/znQm94T4fCEsy/yV+7CdC1kJhOU9lboAEU7R3kquuycDoibVA==", + "license": "MIT", + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/webpack-merge": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-6.0.1.tgz", + "integrity": "sha512-hXXvrjtx2PLYx4qruKl+kyRSLc52V+cCvMxRjmKwoA+CBbbF5GfIBtR6kCvl0fYGqTUPKB+1ktVmTHqMOzgCBg==", + "license": "MIT", + "dependencies": { + "clone-deep": "^4.0.1", + "flat": "^5.0.2", + "wildcard": "^2.0.1" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/webpack-sources": { + "version": "3.3.4", + "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.3.4.tgz", + "integrity": "sha512-7tP1PdV4vF+lYPnkMR0jMY5/la2ub5Fc/8VQrrU+lXkiM6C4TjVfGw7iKfyhnTQOsD+6Q/iKw0eFciziRgD58Q==", + "license": "MIT", + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/webpack/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpackbar": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/webpackbar/-/webpackbar-6.0.1.tgz", + "integrity": "sha512-TnErZpmuKdwWBdMoexjio3KKX6ZtoKHRVvLIU0A47R0VVBDtx3ZyOJDktgYixhoJokZTYTt1Z37OkO9pnGJa9Q==", + "license": "MIT", + "dependencies": { + "ansi-escapes": "^4.3.2", + "chalk": "^4.1.2", + "consola": "^3.2.3", + "figures": "^3.2.0", + "markdown-table": "^2.0.0", + "pretty-time": "^1.1.0", + "std-env": "^3.7.0", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=14.21.3" + }, + "peerDependencies": { + "webpack": "3 || 4 || 5" + } + }, + "node_modules/webpackbar/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/webpackbar/node_modules/markdown-table": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-2.0.0.tgz", + "integrity": "sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A==", + "license": "MIT", + "dependencies": { + "repeat-string": "^1.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/webpackbar/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/webpackbar/node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/websocket-driver": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/websocket-driver/-/websocket-driver-0.7.4.tgz", + "integrity": "sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg==", + "license": "Apache-2.0", + "dependencies": { + "http-parser-js": ">=0.5.1", + "safe-buffer": ">=5.1.0", + "websocket-extensions": ">=0.1.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/websocket-extensions": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/websocket-extensions/-/websocket-extensions-0.1.4.tgz", + "integrity": "sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg==", + "license": "Apache-2.0", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/whatwg-encoding": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", + "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==", + "deprecated": "Use @exodus/bytes instead for a more spec-conformant and faster implementation", + "license": "MIT", + "dependencies": { + "iconv-lite": "0.6.3" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/whatwg-encoding/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/whatwg-mimetype": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", + "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/widest-line": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", + "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", + "license": "MIT", + "dependencies": { + "string-width": "^5.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/wildcard": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/wildcard/-/wildcard-2.0.1.tgz", + "integrity": "sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==", + "license": "MIT" + }, + "node_modules/wrap-ansi": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", + "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-styles": { + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/strip-ansi": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.2.2" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/write-file-atomic": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", + "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", + "license": "ISC", + "dependencies": { + "imurmurhash": "^0.1.4", + "is-typedarray": "^1.0.0", + "signal-exit": "^3.0.2", + "typedarray-to-buffer": "^3.1.5" + } + }, + "node_modules/ws": { + "version": "7.5.10", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz", + "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==", + "license": "MIT", + "engines": { + "node": ">=8.3.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/wsl-utils": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/wsl-utils/-/wsl-utils-0.1.0.tgz", + "integrity": "sha512-h3Fbisa2nKGPxCpm89Hk33lBLsnaGBvctQopaBSOW/uIs6FTe1ATyAnKFJrzVs9vpGdsTe73WF3V4lIsk4Gacw==", + "license": "MIT", + "dependencies": { + "is-wsl": "^3.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/wsl-utils/node_modules/is-wsl": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.1.tgz", + "integrity": "sha512-e6rvdUCiQCAuumZslxRJWR/Doq4VpPR82kqclvcS0efgt430SlGIk05vdCN58+VrzgtIcfNODjozVielycD4Sw==", + "license": "MIT", + "dependencies": { + "is-inside-container": "^1.0.0" + }, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/xdg-basedir": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", + "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/xml-js": { + "version": "1.6.11", + "resolved": "https://registry.npmjs.org/xml-js/-/xml-js-1.6.11.tgz", + "integrity": "sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g==", + "license": "MIT", + "dependencies": { + "sax": "^1.2.4" + }, + "bin": { + "xml-js": "bin/cli.js" + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "license": "ISC" + }, + "node_modules/yaml": { + "version": "2.8.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.3.tgz", + "integrity": "sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==", + "dev": true, + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" + } + }, + "node_modules/yocto-queue": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", + "integrity": "sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==", + "license": "MIT", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/zwitch": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", + "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } } - } - }, - "node_modules/wsl-utils": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/wsl-utils/-/wsl-utils-0.1.0.tgz", - "integrity": "sha512-h3Fbisa2nKGPxCpm89Hk33lBLsnaGBvctQopaBSOW/uIs6FTe1ATyAnKFJrzVs9vpGdsTe73WF3V4lIsk4Gacw==", - "license": "MIT", - "dependencies": { - "is-wsl": "^3.1.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/wsl-utils/node_modules/is-wsl": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.1.tgz", - "integrity": "sha512-e6rvdUCiQCAuumZslxRJWR/Doq4VpPR82kqclvcS0efgt430SlGIk05vdCN58+VrzgtIcfNODjozVielycD4Sw==", - "license": "MIT", - "dependencies": { - "is-inside-container": "^1.0.0" - }, - "engines": { - "node": ">=16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/xdg-basedir": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", - "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/xml-js": { - "version": "1.6.11", - "resolved": "https://registry.npmjs.org/xml-js/-/xml-js-1.6.11.tgz", - "integrity": "sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g==", - "license": "MIT", - "dependencies": { - "sax": "^1.2.4" - }, - "bin": { - "xml-js": "bin/cli.js" - } - }, - "node_modules/yallist": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", - "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", - "license": "ISC" - }, - "node_modules/yaml": { - "version": "2.8.3", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.3.tgz", - "integrity": "sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==", - "dev": true, - "license": "ISC", - "bin": { - "yaml": "bin.mjs" - }, - "engines": { - "node": ">= 14.6" - }, - "funding": { - "url": "https://github.com/sponsors/eemeli" - } - }, - "node_modules/yocto-queue": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", - "integrity": "sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==", - "license": "MIT", - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/zwitch": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", - "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } } - } } diff --git a/website/package.json b/website/package.json index 0cd555dea60..975f69dcf16 100644 --- a/website/package.json +++ b/website/package.json @@ -1,54 +1,55 @@ { - "name": "website", - "version": "0.0.0", - "private": true, - "scripts": { - "prebuild": "node scripts/transform-gen-docs.mjs", - "prestart": "node scripts/transform-gen-docs.mjs", - "docusaurus": "docusaurus", - "start": "docusaurus start", - "build": "docusaurus build", - "swizzle": "docusaurus swizzle", - "deploy": "docusaurus deploy", - "clear": "docusaurus clear", - "serve": "docusaurus serve", - "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids", - "typecheck": "tsc", - "test": "node --experimental-vm-modules node_modules/.bin/jest scripts/__tests__/transform.test.mjs" - }, - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/preset-classic": "3.9.2", - "@easyops-cn/docusaurus-search-local": "^0.55.1", - "@mdx-js/react": "^3.0.0", - "clsx": "^2.0.0", - "prism-react-renderer": "^2.3.0", - "react": "^19.0.0", - "react-dom": "^19.0.0" - }, - "devDependencies": { - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/tsconfig": "3.9.2", - "@docusaurus/types": "3.9.2", - "docusaurus-plugin-typedoc": "^1.4.2", - "typedoc": "^0.28.18", - "typedoc-plugin-markdown": "^4.11.0", - "typescript": "~5.6.2" - }, - "browserslist": { - "production": [ - ">0.5%", - "not dead", - "not op_mini all" - ], - "development": [ - "last 3 chrome version", - "last 3 firefox version", - "last 5 safari version" - ] - }, - "engines": { - "node": ">=20.0" - } -} + "name": "website", + "version": "0.0.0", + "private": true, + "scripts": { + "prebuild": "node scripts/transform-gen-docs.mjs && node scripts/generate-models.mjs", + "prestart": "node scripts/transform-gen-docs.mjs && node scripts/generate-models.mjs", + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids", + "typecheck": "tsc", + "test": "node --experimental-vm-modules node_modules/.bin/jest scripts/__tests__/transform.test.mjs" + }, + "dependencies": { + "@docusaurus/core": "3.9.2", + "@docusaurus/preset-classic": "3.9.2", + "@easyops-cn/docusaurus-search-local": "^0.55.1", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "prism-react-renderer": "^2.3.0", + "react": "^19.0.0", + "react-dom": "^19.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", + "@docusaurus/types": "3.9.2", + "docusaurus-plugin-typedoc": "^1.4.2", + "raw-loader": "^4.0.2", + "typedoc": "^0.28.18", + "typedoc-plugin-markdown": "^4.11.0", + "typescript": "~5.6.2" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" + ] + }, + "engines": { + "node": ">=20.0" + } +} \ No newline at end of file diff --git a/website/scripts/enrich-sdk-docs.mjs b/website/scripts/enrich-sdk-docs.mjs new file mode 100644 index 00000000000..a63e331f6c5 --- /dev/null +++ b/website/scripts/enrich-sdk-docs.mjs @@ -0,0 +1,75 @@ +/** + * Enriches generated SDK docs with quick-start snippets and cross-links. + * Runs after typedoc + flatten, before Docusaurus compiles the docs. + */ + +import { readFileSync, writeFileSync, existsSync } from 'node:fs'; +import { dirname, join, resolve } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = dirname(__filename); +const SDK_DIR = resolve(__dirname, '../docs/sdk'); + +const ENRICHMENTS = [ + { + file: 'config/classes/KubeConfig.md', + snippet: '> **Quick start:** `const kc = new KubeConfig(); kc.loadFromDefault(); const api = kc.makeApiClient(CoreV1Api);` — [See examples](/examples/basic-operations)', + }, + { + file: 'exec/index.md', + snippet: '> **Quick start:** `const exec = new Exec(kc); exec.exec(ns, pod, container, command, stdout, stderr, stdin, tty);` — [See examples](/examples/pod-operations)', + }, + { + file: 'watch/index.md', + snippet: '> **Quick start:** `const watch = new Watch(kc); watch.watch(path, params, callback, done);` — [See examples](/examples/watching-and-caching)', + }, + { + file: 'informer/functions/makeInformer.md', + snippet: '> **Quick start:** `const informer = makeInformer(kc, path, listFn); informer.on("add", obj => {}); informer.start();` — [See examples](/examples/watching-and-caching)', + }, + { + file: 'yaml/index.md', + snippet: '> **Quick start:** `loadYaml(yamlString)` / `loadAllYaml(multiDocYaml)` / `dumpYaml(obj)` — [See examples](/examples/advanced)', + }, + { + file: 'attach/index.md', + snippet: '> **Quick start:** `const attach = new Attach(kc); attach.attach(ns, pod, container, stdout, stderr, stdin, tty);` — [See examples](/examples/pod-operations)', + }, + { + file: 'portforward/index.md', + snippet: '> **Quick start:** `const fwd = new PortForward(kc); fwd.portForward(ns, pod, [port], output, null, input);` — [See examples](/examples/pod-operations)', + }, + { + file: 'cp/index.md', + snippet: '> **Quick start:** `const cp = new Cp(kc); cp.cpFromPod(ns, pod, container, srcPath, destPath);` — [See examples](/examples/pod-operations)', + }, + { + file: 'log/index.md', + snippet: '> **Quick start:** `const log = new Log(kc); log.log(ns, pod, container, stream, opts);` — [See examples](/examples/pod-operations)', + }, +]; + +export function enrichSdkDocs(sdkDir = SDK_DIR) { + let count = 0; + for (const { file, snippet } of ENRICHMENTS) { + const filePath = join(sdkDir, file); + if (!existsSync(filePath)) continue; + + let content = readFileSync(filePath, 'utf8'); + + // Skip if already enriched + if (content.includes('**Quick start:**')) continue; + + // Insert after the first heading line (# ...) + const headingMatch = content.match(/^(#\s+.+\n)/m); + if (!headingMatch) continue; + + const insertPos = headingMatch.index + headingMatch[0].length; + content = content.slice(0, insertPos) + '\n' + snippet + '\n' + content.slice(insertPos); + + writeFileSync(filePath, content, 'utf8'); + count++; + } + return count; +} diff --git a/website/scripts/flatten-sdk-docs.mjs b/website/scripts/flatten-sdk-docs.mjs new file mode 100644 index 00000000000..0c0ce47b99a --- /dev/null +++ b/website/scripts/flatten-sdk-docs.mjs @@ -0,0 +1,304 @@ +#!/usr/bin/env node + +/** + * Post-processes typedoc-generated SDK docs to flatten shallow modules. + * + * - Single-doc modules (e.g. attach with only Attach.md): merges the content + * into index.md so the module IS the page (no tile navigation). + * - Small modules (≤ SMALL_THRESHOLD docs): removes the classes/functions/etc + * sub-directory grouping and moves docs up to the module root. + * + * Run AFTER typedoc generates and BEFORE Docusaurus builds. + */ + +import { readdirSync, readFileSync, writeFileSync, rmSync, mkdirSync, existsSync, renameSync, statSync } from 'node:fs'; +import { dirname, join, resolve, extname } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = dirname(__filename); + +const SDK_DIR = resolve(__dirname, '../docs/sdk'); + +/** Modules with this many content docs or fewer get sub-dirs flattened. */ +const SMALL_THRESHOLD = 4; + +/** + * Collect all .md files in a module dir that are NOT index.md, + * recursing into sub-directories (classes/, functions/, etc.). + */ +function collectContentFiles(moduleDir) { + const results = []; + + function walk(dir, rel) { + for (const entry of readdirSync(dir, { withFileTypes: true })) { + const fullPath = join(dir, entry.name); + const relPath = rel ? `${rel}/${entry.name}` : entry.name; + if (entry.isDirectory()) { + walk(fullPath, relPath); + } else if (entry.isFile() && extname(entry.name) === '.md' && entry.name !== 'index.md') { + results.push({ fullPath, relPath, name: entry.name }); + } + } + } + + walk(moduleDir, ''); + return results; +} + +/** + * Get sub-directories in a module dir (classes, functions, interfaces, etc.). + */ +function getSubDirs(moduleDir) { + return readdirSync(moduleDir, { withFileTypes: true }) + .filter(e => e.isDirectory()) + .map(e => e.name); +} + +/** + * Strip the typedoc-generated title heading (# Class: Foo / # Function: bar()) + * and return { title, body }. + */ +function parseContent(raw) { + const lines = raw.split('\n'); + let titleLine = ''; + let bodyStart = 0; + + for (let i = 0; i < lines.length; i++) { + if (lines[i].startsWith('# ')) { + titleLine = lines[i]; + bodyStart = i + 1; + // Skip blank line after title + if (lines[bodyStart]?.trim() === '') bodyStart++; + break; + } + } + + return { + title: titleLine.replace(/^#\s+/, ''), + body: lines.slice(bodyStart).join('\n').trim(), + }; +} + +/** + * Single-doc module: replace index.md with the content of the sole doc. + */ +function mergeSingleDoc(moduleDir, moduleName, contentFile) { + const raw = readFileSync(contentFile.fullPath, 'utf8'); + const { title, body } = parseContent(raw); + + const frontmatter = [ + '---', + `sidebar_label: ${moduleName}`, + '---', + '', + ].join('\n'); + + // Fix relative links: moved from classes/Foo.md to index.md (one level up). + const fixedBody = body.replace(/(?:\.\.\/){2,}/g, (match) => match.slice(3)); + const merged = `${frontmatter}# ${title}\n\n${fixedBody}\n`; + writeFileSync(join(moduleDir, 'index.md'), merged, 'utf8'); + + // Remove all sub-directories. + for (const sub of getSubDirs(moduleDir)) { + rmSync(join(moduleDir, sub), { recursive: true, force: true }); + } + + return { type: 'single', moduleName, title }; +} + +/** + * Small module: flatten sub-dirs so docs live directly under the module dir. + * Keeps index.md but rewrites it to list the flattened docs. + */ +function flattenSmallModule(moduleDir, moduleName, contentFiles) { + const subDirs = getSubDirs(moduleDir); + + // Move all content files up to the module root, prefixing with category + // to avoid name collisions (e.g. type-aliases/PatchStrategy.md vs variables/PatchStrategy.md). + const movedFiles = []; + + for (const sub of subDirs) { + const subPath = join(moduleDir, sub); + const files = readdirSync(subPath).filter(f => extname(f) === '.md'); + + for (const file of files) { + const src = join(subPath, file); + + // Check for name collision — if the filename already exists at module root + // or we already moved one with the same name, prefix with sub-dir name. + const baseName = file; + const needsPrefix = movedFiles.some(m => m.fileName === baseName) || + existsSync(join(moduleDir, baseName)); + const destName = needsPrefix ? `${sub}-${baseName}` : baseName; + const dest = join(moduleDir, destName); + + // Read content and fix relative links (go up one fewer level since we moved up). + // Files moved from sdk/mod/classes/Foo.md -> sdk/mod/Foo.md (one level up). + // So ../../other -> ../other (remove one ../ from every consecutive run). + let content = readFileSync(src, 'utf8'); + content = content.replace(/(?:\.\.\/){2,}/g, (match) => { + // Remove one level of ../ from the chain + return match.slice(3); + }); + + writeFileSync(dest, content, 'utf8'); + movedFiles.push({ fileName: destName, fromSub: sub, original: file }); + } + } + + // Rewrite index.md: simple list grouped by original category. + const grouped = {}; + for (const m of movedFiles) { + const label = m.fromSub.replace(/-/g, ' ').replace(/\b\w/g, c => c.toUpperCase()); + if (!grouped[label]) grouped[label] = []; + grouped[label].push(m); + } + + let indexContent = `---\nsidebar_label: ${moduleName}\n---\n\n# ${moduleName}\n\n`; + for (const [label, files] of Object.entries(grouped)) { + indexContent += `## ${label}\n\n`; + for (const f of files) { + const docTitle = f.original.replace(/\.md$/, ''); + indexContent += `- [${docTitle}](${f.fileName})\n`; + } + indexContent += '\n'; + } + + writeFileSync(join(moduleDir, 'index.md'), indexContent, 'utf8'); + + // Remove now-empty sub-directories. + for (const sub of subDirs) { + rmSync(join(moduleDir, sub), { recursive: true, force: true }); + } + + return { type: 'flattened', moduleName, count: movedFiles.length }; +} + +export function flattenSdkDocs(sdkDir = SDK_DIR) { + if (!existsSync(sdkDir)) return []; + const modules = readdirSync(sdkDir, { withFileTypes: true }) + .filter(e => e.isDirectory()) + .map(e => e.name); + + const results = []; + + for (const moduleName of modules) { + const moduleDir = join(sdkDir, moduleName); + const contentFiles = collectContentFiles(moduleDir); + const subDirs = getSubDirs(moduleDir); + + // Skip modules with no sub-directories (already flat). + if (subDirs.length === 0) continue; + + if (contentFiles.length === 1) { + const r = mergeSingleDoc(moduleDir, moduleName, contentFiles[0]); + results.push(r); + } else if (contentFiles.length <= SMALL_THRESHOLD) { + const r = flattenSmallModule(moduleDir, moduleName, contentFiles); + results.push(r); + } + // Larger modules are left as-is. + } + + return results; +} + +if (process.argv[1] && resolve(process.argv[1]) === __filename) { + const results = flattenSdkDocs(); + for (const r of results) { + if (r.type === 'single') { + console.log(` merged: ${r.moduleName} (${r.title})`); + } else { + console.log(` flattened: ${r.moduleName} (${r.count} docs)`); + } + } + console.log(`Flattened ${results.length} SDK modules`); +} + +/** + * After flattening, fix relative links in ALL SDK docs that reference + * files that moved during flatten. For example: + * ../../watch/classes/Watch.md -> ../../watch/index.md (merged) + * ../patch/type-aliases/PatchStrategy.md -> ../patch/PatchStrategy.md (flattened) + */ +export function fixCrossReferences(sdkDir = SDK_DIR) { + const allMdFiles = []; + + function walk(dir) { + for (const entry of readdirSync(dir, { withFileTypes: true })) { + const full = join(dir, entry.name); + if (entry.isDirectory()) walk(full); + else if (entry.name.endsWith('.md')) allMdFiles.push(full); + } + } + walk(sdkDir); + + let totalFixes = 0; + + for (const file of allMdFiles) { + let content = readFileSync(file, 'utf8'); + let changed = false; + + // Match relative links: [text](../some/path.md) or [text](../../some/path.md) + content = content.replace( + /\]\((\.\.[^)]+\.md)\)/g, + (full, relPath) => { + const absTarget = resolve(dirname(file), relPath); + + // If the target exists, leave it alone. + if (existsSync(absTarget)) return full; + + // Try to find the file after flatten: + const parts = relPath.replace(/\\/g, '/').split('/'); + const fileName = parts[parts.length - 1]; + + // 1. Try: remove the sub-dir (classes/, functions/, etc.) + // e.g. ../watch/classes/Watch.md -> ../watch/Watch.md + if (parts.length >= 3) { + const withoutSubDir = [...parts.slice(0, -2), fileName].join('/'); + const resolved = resolve(dirname(file), withoutSubDir); + if (existsSync(resolved)) { + changed = true; + totalFixes++; + return `](${withoutSubDir})`; + } + } + + // 2. Try: merged into index.md + // e.g. ../watch/classes/Watch.md -> ../watch/index.md + if (parts.length >= 3) { + const moduleDir = parts.slice(0, -2).join('/'); + const indexPath = moduleDir + '/index.md'; + const resolved = resolve(dirname(file), indexPath); + if (existsSync(resolved)) { + changed = true; + totalFixes++; + return `](${indexPath})`; + } + } + + // 3. Try: within same module, sub-dir removed + // e.g. ../variables/PatchStrategy.md -> PatchStrategy.md (from same module) + // or ../interfaces/LogOptions.md -> LogOptions.md + if (parts.length === 2 && parts[0] === '..') { + // This means we're in a flattened module looking at a sibling sub-dir + const siblingFile = resolve(dirname(file), fileName); + if (existsSync(siblingFile)) { + changed = true; + totalFixes++; + return `](${fileName})`; + } + } + + return full; // Can't resolve — leave as-is + }, + ); + + if (changed) { + writeFileSync(file, content, 'utf8'); + } + } + + return totalFixes; +} diff --git a/website/scripts/generate-models.mjs b/website/scripts/generate-models.mjs new file mode 100644 index 00000000000..0fde413cc1b --- /dev/null +++ b/website/scripts/generate-models.mjs @@ -0,0 +1,302 @@ +#!/usr/bin/env node + +/** + * Generates model reference pages from TypeScript source files. + * Only includes models that are actually referenced in the API docs. + * Groups models into a small number of pages by API group prefix. + */ + +import { readFileSync, readdirSync, writeFileSync, mkdirSync, existsSync } from 'node:fs'; +import { dirname, join, resolve } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = dirname(__filename); + +const MODELS_DIR = resolve(__dirname, '../../src/gen/models'); +const API_DOCS_DIR = resolve(__dirname, '../docs/api-reference'); +const OUTPUT_DIR = resolve(__dirname, '../docs/models'); +const GITHUB_BASE = 'https://github.com/kubernetes-client/javascript/blob/main/src/gen/models'; + +function collectReferencedTypes() { + const types = new Set(); + const pattern = /V\d(?:alpha\d|beta\d)?[A-Z][A-Za-z]*/g; + + function walkDir(dir) { + for (const entry of readdirSync(dir, { withFileTypes: true })) { + const full = join(dir, entry.name); + if (entry.isDirectory()) { + walkDir(full); + } else if (entry.name.endsWith('.md')) { + const content = readFileSync(full, 'utf8'); + for (const match of content.matchAll(pattern)) { + const name = match[0]; + if (!name.endsWith('Api')) { + const tsFile = join(MODELS_DIR, `${name}.ts`); + if (existsSync(tsFile)) types.add(name); + } + } + } + } + } + + walkDir(API_DOCS_DIR); + return [...types].sort(); +} + +function parseModelFile(typeName) { + const filePath = join(MODELS_DIR, `${typeName}.ts`); + const content = readFileSync(filePath, 'utf8'); + + const classDocMatch = content.match(/\/\*\*\s*\n\s*\*\s*(.+?)\s*\n\s*\*\//); + let description = ''; + + const lines = content.split('\n'); + for (let i = 0; i < lines.length; i++) { + if (lines[i].includes('export class')) { + if (i > 0 && lines[i - 1].trim() === '*/') { + for (let j = i - 1; j >= 0; j--) { + if (lines[j].trim().startsWith('/**')) { + const block = lines.slice(j, i).join('\n'); + const descMatch = block.match(/\*\s*([^@*][^\n]*)/); + if (descMatch) description = descMatch[1].trim(); + break; + } + } + } + break; + } + } + + const properties = []; + const propPattern = /\/\*\*\s*\n\s*\*\s*(.*?)\s*\n\s*\*\/\s*\n\s*'(\w+)'\??\s*:\s*([^;]+)/g; + let propMatch; + while ((propMatch = propPattern.exec(content)) !== null) { + properties.push({ + doc: propMatch[1].trim(), + name: propMatch[2], + type: propMatch[3].trim(), + }); + } + + const bareProps = /^\s+'(\w+)'\??\s*:\s*([^;]+);/gm; + const documentedNames = new Set(properties.map(p => p.name)); + let bareMatch; + while ((bareMatch = bareProps.exec(content)) !== null) { + if (!documentedNames.has(bareMatch[1]) && bareMatch[1] !== 'discriminator' && bareMatch[1] !== 'mapping' && bareMatch[1] !== 'attributeTypeMap') { + properties.push({ + doc: '', + name: bareMatch[1], + type: bareMatch[2].trim(), + }); + } + } + + return { typeName, description, properties }; +} + +function formatType(typeStr) { + return typeStr + .replace(/Array<(\w+)>/g, '$1[]') + .replace(/\{ \[key: string\]: string; \}/g, 'Record'); +} + +function typeLink(typeStr) { + return typeStr.replace( + /\b(V\d(?:alpha\d|beta\d)?[A-Z]\w+)\b/g, + (m) => { + const tsFile = join(MODELS_DIR, `${m}.ts`); + if (existsSync(tsFile)) return `[${m}](#${m.toLowerCase()})`; + return m; + } + ); +} + +const GROUP_MAP = { + 'Core': /^V1(Pod|Service|Node|Namespace|ConfigMap|Secret|Endpoint|Event|Binding|Component|LimitRange|PersistentVolume|ReplicationController|ResourceQuota|PodTemplate|ServiceAccount|API)/, + 'Workloads': /^V1(Deployment|StatefulSet|DaemonSet|ReplicaSet|ControllerRevision|Job|CronJob|HorizontalPodAutoscaler|Scale)/, + 'Networking': /^V1(Ingress|NetworkPolicy|EndpointSlice|IPAddress|ServiceCIDR)/, + 'Security': /^V1(ClusterRole|Role|CertificateSigningRequest|TokenReview|SubjectAccessReview|SelfSubjectAccessReview|SelfSubjectRulesReview|LocalSubjectAccessReview|TokenRequest)/, + 'Configuration & Storage': /^V1(StorageClass|VolumeAttachment|CSI|Lease|FlowSchema|PriorityLevelConfiguration|PodDisruptionBudget)/, + 'Cluster': /^V1(CustomResourceDefinition|MutatingWebhookConfiguration|ValidatingWebhookConfiguration|ValidatingAdmissionPolicy|PriorityClass|Scheduling|Admission)/, +}; + +function groupType(typeName) { + for (const [group, pattern] of Object.entries(GROUP_MAP)) { + if (pattern.test(typeName)) return group; + } + return 'Other'; +} + +/** + * Scan API reference docs to find which methods use each model type + * (as body param or return type). Returns a Map of typeName -> [{ method, page }]. + */ +function collectModelUsage() { + const usage = new Map(); + const pattern = /\b(V\d(?:alpha\d|beta\d)?[A-Z]\w+)\b/g; + + function walkDir(dir) { + for (const entry of readdirSync(dir, { withFileTypes: true })) { + const full = join(dir, entry.name); + if (entry.isDirectory()) { + walkDir(full); + } else if (entry.name.endsWith('.md')) { + const content = readFileSync(full, 'utf8'); + // Find method headings and their associated types + const lines = content.split('\n'); + let currentMethod = null; + // Derive the page path from the file path + const relPath = full.replace(/.*\/docs\//, '/').replace(/\.md$/, '').replace(/\/index$/, ''); + for (const line of lines) { + const methodMatch = line.match(/^#{2,3}\s+([a-z]\w+)\s*$/); + if (methodMatch) { + currentMethod = methodMatch[1]; + continue; + } + if (!currentMethod) continue; + // Look for model types in signature, param table, and return type lines + if (line.includes('V1') || line.includes('V2')) { + for (const m of line.matchAll(pattern)) { + const typeName = m[0]; + if (typeName.endsWith('Api') || typeName.endsWith('Request')) continue; + if (!usage.has(typeName)) usage.set(typeName, []); + const refs = usage.get(typeName); + const ref = { method: currentMethod, page: relPath }; + // Deduplicate + if (!refs.some(r => r.method === ref.method && r.page === ref.page)) { + refs.push(ref); + } + } + } + // Reset on next heading + if (line.match(/^#{2,3}\s/)) currentMethod = null; + } + } + } + } + + walkDir(API_DOCS_DIR); + return usage; +} + +function generateModelPage(group, models, modelUsage) { + const slug = group.toLowerCase().replace(/[^a-z0-9]+/g, '-'); + const lines = [ + '---', + `id: ${slug}`, + `title: "API Models: ${group}"`, + `sidebar_label: ${group}`, + 'toc_max_heading_level: 2', + '---', + '', + `# ${group} Models`, + '', + ]; + + for (const model of models) { + lines.push(`## ${model.typeName}`); + lines.push(''); + if (model.description) { + lines.push(model.description); + lines.push(''); + } + lines.push(`[Source](${GITHUB_BASE}/${model.typeName}.ts)`); + lines.push(''); + + if (model.properties.length > 0) { + lines.push('| Property | Type | Description |'); + lines.push('|----------|------|-------------|'); + for (const prop of model.properties) { + const type = typeLink(formatType(prop.type)); + const doc = prop.doc.length > 200 + ? prop.doc.slice(0, 200).replace(/\s\S*$/, '') + '...' + : prop.doc; + lines.push(`| \`${prop.name}\` | \`${type}\` | ${doc} |`); + } + lines.push(''); + } + + // Add "Used by" reverse links to API methods + const refs = modelUsage?.get(model.typeName); + if (refs && refs.length > 0) { + // Deduplicate by page and pick at most 8 representative methods + const byPage = new Map(); + for (const ref of refs) { + if (!byPage.has(ref.page)) byPage.set(ref.page, []); + byPage.get(ref.page).push(ref.method); + } + const links = []; + for (const [page, methods] of byPage) { + const label = page.split('/').pop(); + const methodAnchors = methods.slice(0, 3).map(m => `[\`${m}\`](${page}#${m})`); + links.push(...methodAnchors); + } + if (links.length > 0) { + const INLINE_LIMIT = 20; + if (links.length <= INLINE_LIMIT) { + lines.push(`**Used by:** ${links.join(' · ')}`); + } else { + const shown = links.slice(0, INLINE_LIMIT); + const rest = links.slice(INLINE_LIMIT); + lines.push(`**Used by:** ${shown.join(' · ')}`); + lines.push(''); + lines.push(`
and ${rest.length} more…`); + lines.push(''); + lines.push(rest.join(' · ')); + lines.push(''); + lines.push('
'); + } + lines.push(''); + } + } + } + + return { slug, content: lines.join('\n') }; +} + +export function generateModels() { + const referencedTypes = collectReferencedTypes(); + console.log(`Found ${referencedTypes.length} referenced model types`); + + const models = referencedTypes.map(parseModelFile); + const modelUsage = collectModelUsage(); + + const groups = new Map(); + for (const model of models) { + const group = groupType(model.typeName); + if (!groups.has(group)) groups.set(group, []); + groups.get(group).push(model); + } + + mkdirSync(OUTPUT_DIR, { recursive: true }); + + const groupOrder = ['Core', 'Workloads', 'Networking', 'Security', 'Configuration & Storage', 'Cluster', 'Other']; + let position = 1; + const results = []; + + for (const group of groupOrder) { + const groupModels = groups.get(group); + if (!groupModels || groupModels.length === 0) continue; + + const { slug, content } = generateModelPage(group, groupModels, modelUsage); + writeFileSync(join(OUTPUT_DIR, `${slug}.md`), content, 'utf8'); + results.push({ group, slug, count: groupModels.length }); + position++; + } + + writeFileSync( + join(OUTPUT_DIR, '_category_.json'), + JSON.stringify({ label: 'API Models', position: 4 }, null, 2) + '\n', + 'utf8', + ); + + return results; +} + +if (process.argv[1] && resolve(process.argv[1]) === __filename) { + const results = generateModels(); + for (const r of results) { + console.log(` ${r.group}: ${r.count} models -> ${r.slug}.md`); + } +} diff --git a/website/scripts/plugin-flatten-sdk.mjs b/website/scripts/plugin-flatten-sdk.mjs new file mode 100644 index 00000000000..436b04c0e80 --- /dev/null +++ b/website/scripts/plugin-flatten-sdk.mjs @@ -0,0 +1,34 @@ +/** + * Docusaurus plugin that flattens SDK docs after typedoc generates them. + * Runs in the `loadContent` lifecycle, which executes after all plugins + * have initialized (including typedoc). + */ + +import { flattenSdkDocs, fixCrossReferences } from './flatten-sdk-docs.mjs'; +import { enrichSdkDocs } from './enrich-sdk-docs.mjs'; + +export default function pluginFlattenSdk() { + return { + name: 'flatten-sdk-docs', + async loadContent() { + const results = flattenSdkDocs(); + if (results.length > 0) { + for (const r of results) { + if (r.type === 'single') { + console.log(` [flatten] merged: ${r.moduleName} (${r.title})`); + } else { + console.log(` [flatten] flattened: ${r.moduleName} (${r.count} docs)`); + } + } + } + const fixes = fixCrossReferences(); + if (fixes > 0) { + console.log(` [flatten] fixed ${fixes} cross-reference(s)`); + } + const enriched = enrichSdkDocs(); + if (enriched > 0) { + console.log(` [flatten] enriched ${enriched} SDK page(s) with quick-start snippets`); + } + }, + }; +} diff --git a/website/scripts/remark-example-links.mjs b/website/scripts/remark-example-links.mjs new file mode 100644 index 00000000000..7d5c801a6da --- /dev/null +++ b/website/scripts/remark-example-links.mjs @@ -0,0 +1,303 @@ +/** + * Remark plugin that auto-injects "Related" links below each in + * example doc pages. It reads the referenced example source file at build + * time, detects which SDK classes / API groups are used, and emits a + * blockquote with links to the matching doc pages. + * + * The plugin is stateless — it derives everything from the example source + * and the doc files on disk, so it stays in sync automatically when examples + * or doc pages change. + */ + +import fs from 'node:fs'; +import path from 'node:path'; +import { visit } from 'unist-util-visit'; + +/* ------------------------------------------------------------------ */ +/* Mapping from detected patterns → doc page paths */ +/* ------------------------------------------------------------------ */ + +// SDK classes / functions → doc path (relative to docs root, no extension) +const SDK_PATTERNS = [ + { re: /\bKubeConfig\b/, label: 'KubeConfig', path: '/sdk/config/classes/KubeConfig' }, + { re: /\bWatch\b/, label: 'Watch', path: '/sdk/watch/classes/Watch' }, + { re: /\bmakeInformer\b/, label: 'makeInformer', path: '/sdk/informer/functions/makeInformer' }, + { + re: /\bInformer\b/, + label: 'Informer', + path: '/sdk/informer/interfaces/Informer', + // only if makeInformer is also present (avoid false positives from comments) + requires: /\bmakeInformer\b/, + }, + { re: /\bListWatch\b/, label: 'ListWatch', path: '/sdk/cache/classes/ListWatch' }, + { re: /\bObjectCache\b/, label: 'ObjectCache', path: '/sdk/cache/interfaces/ObjectCache' }, + { re: /\bExec\b/, label: 'Exec', path: '/sdk/exec/classes/Exec' }, + { re: /\bAttach\b/, label: 'Attach', path: '/sdk/attach/classes/Attach' }, + { re: /\bPortForward\b/, label: 'PortForward', path: '/sdk/portforward/classes/PortForward' }, + { re: /\bCp\b/, label: 'Cp', path: '/sdk/cp/classes/Cp' }, + { re: /\bLog\b/, label: 'Log', path: '/sdk/log/classes/Log', requires: /new\s+\w*\.?Log\b/ }, + { re: /\bMetrics\b/, label: 'Metrics', path: '/sdk/metrics/classes/Metrics' }, + { re: /\btopNodes\b/, label: 'topNodes', path: '/sdk/top/functions/topNodes' }, + { re: /\btopPods\b/, label: 'topPods', path: '/sdk/top/functions/topPods' }, + { re: /\bPatchStrategy\b/, label: 'PatchStrategy', path: '/sdk/patch/type-aliases/PatchStrategy' }, + { + re: /\bKubernetesObjectApi\b/, + label: 'KubernetesObjectApi', + path: '/sdk/object/classes/KubernetesObjectApi', + }, + { re: /\bloadYaml\b/, label: 'loadYaml', path: '/sdk/yaml/functions/loadYaml' }, + { re: /\bloadAllYaml\b/, label: 'loadAllYaml', path: '/sdk/yaml/functions/loadAllYaml' }, + { re: /\bdumpYaml\b/, label: 'dumpYaml', path: '/sdk/yaml/functions/dumpYaml' }, + { re: /\bHealth\b/, label: 'Health', path: '/sdk/health/classes/Health' }, +]; + +// API classes → doc path +const API_PATTERNS = [ + { re: /\bCoreV1Api\b/, label: 'CoreV1Api', path: '/api-reference/core-resources/CoreV1Api' }, + { re: /\bAppsV1Api\b/, label: 'AppsV1Api', path: '/api-reference/workloads/AppsV1Api' }, + { re: /\bBatchV1Api\b/, label: 'BatchV1Api', path: '/api-reference/workloads/BatchV1Api' }, + { + re: /\bNetworkingV1Api\b/, + label: 'NetworkingV1Api', + path: '/api-reference/networking/NetworkingV1Api', + }, + { + re: /\bCustomObjectsApi\b/, + label: 'CustomObjectsApi', + path: '/api-reference/other/CustomObjectsApi', + }, + { re: /\bRbacAuthorizationV1Api\b/, label: 'RbacAuthorizationV1Api', path: '/api-reference/security/RbacAuthorizationV1Api' }, + { re: /\bStorageV1Api\b/, label: 'StorageV1Api', path: '/api-reference/configuration-storage/StorageV1Api' }, + { re: /\bAutoscalingV1Api\b/, label: 'AutoscalingV1Api', path: '/api-reference/other/AutoscalingV1Api' }, + { re: /\bAutoscalingV2Api\b/, label: 'AutoscalingV2Api', path: '/api-reference/other/AutoscalingV2Api' }, + { re: /\bPolicyV1Api\b/, label: 'PolicyV1Api', path: '/api-reference/configuration-storage/PolicyV1Api' }, + { re: /\bApiextensionsV1Api\b/, label: 'ApiextensionsV1Api', path: '/api-reference/cluster/ApiextensionsV1Api' }, + { re: /\bAdmissionregistrationV1Api\b/, label: 'AdmissionregistrationV1Api', path: '/api-reference/cluster/AdmissionregistrationV1Api' }, + { re: /\bEventsV1Api\b/, label: 'EventsV1Api', path: '/api-reference/core-resources/EventsV1Api' }, + { re: /\bDiscoveryV1Api\b/, label: 'DiscoveryV1Api', path: '/api-reference/networking/DiscoveryV1Api' }, + { re: /\bCoordinationV1Api\b/, label: 'CoordinationV1Api', path: '/api-reference/configuration-storage/CoordinationV1Api' }, + { re: /\bSchedulingV1Api\b/, label: 'SchedulingV1Api', path: '/api-reference/cluster/SchedulingV1Api' }, + { re: /\bCertificatesV1Api\b/, label: 'CertificatesV1Api', path: '/api-reference/security/CertificatesV1Api' }, + { re: /\bNodeV1Api\b/, label: 'NodeV1Api', path: '/api-reference/core-resources/NodeV1Api' }, +]; + +// Heuristic: detect which specific CoreV1Api resource sub-page to link to +// based on method names in the source. +// +// K8s client methods follow the pattern: +// verbNamespacedResource(...) e.g. listNamespacedPod, createNamespacedService +// verbResource(...) e.g. listNamespace, createNamespace +// verbResourceForAllNamespaces e.g. listPodForAllNamespaces +// +// The resource name is always at the END of the method name (possibly followed +// by "ForAllNamespaces" or "Status" / "Scale" suffixes). We use a helper to +// build regexes that anchor the resource name correctly so that e.g. +// "createNamespacedPod" matches Pod but NOT Namespace. +function resourceRe(resource) { + return new RegExp( + `\\b(?:list|create|read|delete|patch|replace)(?:Namespaced)?${resource}(?:ForAllNamespaces|Status|Scale)?\\b`, + ); +} + +const CORE_RESOURCE_HINTS = [ + { re: resourceRe('Pod'), label: 'Pod operations', sub: 'pod' }, + { re: resourceRe('Namespace'), label: 'Namespace operations', sub: 'namespace' }, + { re: resourceRe('Service'), label: 'Service operations', sub: 'service' }, + { re: resourceRe('ConfigMap'), label: 'ConfigMap operations', sub: 'config-map' }, + { re: resourceRe('Secret'), label: 'Secret operations', sub: 'secret' }, + { re: resourceRe('Node'), label: 'Node operations', sub: 'node' }, + { re: resourceRe('PersistentVolumeClaim'), label: 'PVC operations', sub: 'persistent-volume-claim' }, + { re: resourceRe('ResourceQuota'), label: 'ResourceQuota operations', sub: 'resource-quota' }, + { re: resourceRe('Event'), label: 'Event operations', sub: 'event' }, + { re: resourceRe('Endpoints'), label: 'Endpoints operations', sub: 'endpoints' }, +]; + +const APPS_RESOURCE_HINTS = [ + { re: resourceRe('Deployment'), label: 'Deployment operations', sub: 'deployment' }, + { re: resourceRe('StatefulSet'), label: 'StatefulSet operations', sub: 'stateful-set' }, + { re: resourceRe('DaemonSet'), label: 'DaemonSet operations', sub: 'daemon-set' }, + { re: resourceRe('ReplicaSet'), label: 'ReplicaSet operations', sub: 'replica-set' }, +]; + +const BATCH_RESOURCE_HINTS = [ + // CronJob must come before Job to avoid false positive + { re: resourceRe('CronJob'), label: 'CronJob operations', sub: 'cron-job' }, + { re: resourceRe('Job'), label: 'Job operations', sub: 'job' }, +]; + +/* ------------------------------------------------------------------ */ +/* Helpers */ +/* ------------------------------------------------------------------ */ + +/** Resolve the repo root (two levels up from this script). */ +const REPO_ROOT = path.resolve(new URL('.', import.meta.url).pathname, '../..'); + +function readExampleSource(exampleRelPath) { + // exampleRelPath looks like "examples/example.js" + const abs = path.join(REPO_ROOT, exampleRelPath); + try { + return fs.readFileSync(abs, 'utf8'); + } catch { + return null; + } +} + +function detectLinks(source) { + const links = []; + const seen = new Set(); + + const docsDir = path.join(REPO_ROOT, 'website', 'docs'); + + /** + * Resolve a doc path to the actual URL after SDK docs are flattened. + * + * Single-doc modules (attach, cp, exec, health, object, portforward, watch) + * get merged into their module index: /sdk/exec/classes/Exec -> /sdk/exec + * + * Small modules (log, middleware, patch, types, yaml) get sub-dirs removed: + * /sdk/yaml/functions/loadYaml -> /sdk/yaml/loadYaml + * + * Large modules (config, config_types, informer, cache, metrics, top) keep + * their original structure. + */ + const MERGED_MODULES = new Set(['attach', 'cp', 'exec', 'health', 'log', 'object', 'portforward', 'watch']); + const FLATTENED_MODULES = new Set(['middleware', 'patch', 'types', 'yaml']); + + function resolveDocPath(docPath) { + const parts = docPath.split('/'); + // Only transform /sdk/module/sub-dir/File paths + if (parts[1] !== 'sdk' || parts.length <= 3) return docPath; + + const moduleName = parts[2]; + const fileName = parts[parts.length - 1]; + + if (MERGED_MODULES.has(moduleName)) { + // Single-doc module: content merged into module index + return parts.slice(0, 3).join('/'); + } + if (FLATTENED_MODULES.has(moduleName)) { + // Small module: sub-dirs removed, files at module root + return `${parts.slice(0, 3).join('/')}/${fileName}`; + } + // Large module: keep original path + return docPath; + } + + function add(label, docPath) { + const resolved = resolveDocPath(docPath); + if (seen.has(resolved)) return; + seen.add(resolved); + links.push({ label, path: resolved }); + } + + // SDK patterns + for (const p of SDK_PATTERNS) { + if (p.re.test(source)) { + if (p.requires && !p.requires.test(source)) continue; + add(p.label, p.path); + } + } + + // API patterns + sub-resource hints + for (const p of API_PATTERNS) { + if (!p.re.test(source)) continue; + add(p.label, p.path); + + // Sub-resource hints for specific APIs + let hints = []; + if (p.label === 'CoreV1Api') hints = CORE_RESOURCE_HINTS; + else if (p.label === 'AppsV1Api') hints = APPS_RESOURCE_HINTS; + else if (p.label === 'BatchV1Api') hints = BATCH_RESOURCE_HINTS; + + for (const h of hints) { + if (h.re.test(source)) { + // Link to sub-page if it exists, otherwise use anchor on parent page. + const subPath = `${p.path}/${h.sub}`; + const subFile = path.join(REPO_ROOT, 'website', 'docs', subPath + '.md'); + const subDir = path.join(REPO_ROOT, 'website', 'docs', subPath); + if (fs.existsSync(subFile) || fs.existsSync(path.join(subDir, 'index.md'))) { + add(h.label, subPath); + } else { + // Fall back to anchor on parent page (resource group heading). + const anchor = h.sub; + add(h.label, `${p.path}#${anchor}`); + } + } + } + } + + return links; +} + +/** Get the `title` attribute value from a CodeBlock JSX node. */ +function getCodeBlockTitle(node) { + if (!node.attributes) return null; + for (const attr of node.attributes) { + if (attr.type === 'mdxJsxAttribute' && attr.name === 'title') { + return attr.value; + } + } + return null; +} + +/** Build a blockquote AST node: > **Related:** [A](link) · [B](link) */ +function buildRelatedBlockquote(links) { + // Build children: bold "Related:" then link · link · link + const children = [ + { type: 'strong', children: [{ type: 'text', value: 'Related:' }] }, + { type: 'text', value: ' ' }, + ]; + + for (let i = 0; i < links.length; i++) { + if (i > 0) { + children.push({ type: 'text', value: ' · ' }); + } + children.push({ + type: 'link', + url: links[i].path, + children: [{ type: 'text', value: links[i].label }], + }); + } + + return { + type: 'blockquote', + children: [{ type: 'paragraph', children }], + }; +} + +/* ------------------------------------------------------------------ */ +/* Plugin */ +/* ------------------------------------------------------------------ */ + +// v2 +export default function remarkExampleLinks() { + return (tree, file) => { + // Only process files under docs/examples/ + const filePath = file.history?.[0] || file.path || ''; + if (!filePath.includes(path.join('docs', 'examples'))) return; + + // Collect insertions (index → node) to avoid mutating during visit + const insertions = []; + + visit(tree, 'mdxJsxFlowElement', (node, index, parent) => { + if (node.name !== 'CodeBlock') return; + + const title = getCodeBlockTitle(node); + if (!title) return; + + const source = readExampleSource(title); + if (!source) return; + + const links = detectLinks(source); + if (links.length === 0) return; + + insertions.push({ parent, index, blockquote: buildRelatedBlockquote(links) }); + }); + + // Insert in reverse order so indices stay valid + for (let i = insertions.length - 1; i >= 0; i--) { + const { parent, index, blockquote } = insertions[i]; + parent.children.splice(index + 1, 0, blockquote); + } + }; +} diff --git a/website/scripts/transform-gen-docs.mjs b/website/scripts/transform-gen-docs.mjs index 7de12821038..f9794efd2fb 100644 --- a/website/scripts/transform-gen-docs.mjs +++ b/website/scripts/transform-gen-docs.mjs @@ -1,6 +1,6 @@ #!/usr/bin/env node -import { readFileSync, readdirSync, mkdirSync, writeFileSync, rmSync } from 'node:fs'; +import { readFileSync, readdirSync, mkdirSync, writeFileSync, rmSync, statSync, existsSync } from 'node:fs'; import { dirname, extname, join, resolve } from 'node:path'; import { fileURLToPath } from 'node:url'; @@ -27,6 +27,15 @@ const CATEGORY_ORDER = [ 'Other', ]; +const SKIP_CLASSES = new Set([ + 'AdmissionregistrationApi', 'ApiextensionsApi', 'ApiregistrationApi', 'ApisApi', + 'AppsApi', 'AuthenticationApi', 'AuthorizationApi', 'AutoscalingApi', 'BatchApi', + 'CertificatesApi', 'CoordinationApi', 'CoreApi', 'DiscoveryApi', 'EventsApi', + 'FlowcontrolApiserverApi', 'InternalApiserverApi', 'LogsApi', 'NetworkingApi', + 'NodeApi', 'OpenidApi', 'PolicyApi', 'RbacAuthorizationApi', 'ResourceApi', + 'SchedulingApi', 'StorageApi', 'StoragemigrationApi', 'VersionApi', 'WellKnownApi', +]); + function toPosixPath(p) { return p.replaceAll('\\\\', '/'); } @@ -72,7 +81,7 @@ function rewriteLinks(content, apiGroupMap, warnings) { return full; } - return `(/docs/api-reference/${slug}/${className}#${anchor})`; + return `(/api-reference/${slug}/${className}#${anchor})`; }); // README references: rewrite BearerToken to local authorization section, drop others to plain text. @@ -83,6 +92,16 @@ function rewriteLinks(content, apiGroupMap, warnings) { return result; } +// Sub-section headings that belong under each method and should be demoted to ####. +const METHOD_SUBSECTIONS = new Set([ + 'Example', + 'Parameters', + 'Return type', + 'Authorization', + 'HTTP request headers', + 'HTTP response details', +]); + function normalizeHeadings(content) { let result = content; @@ -95,6 +114,14 @@ function normalizeHeadings(content) { for (let i = 0; i < lines.length; i += 1) { const line = lines[i]; + + // Demote sub-section headings (### Example -> #### Example) + const subSectionMatch = line.match(/^###\s+(.+)$/); + if (subSectionMatch && METHOD_SUBSECTIONS.has(subSectionMatch[1].trim())) { + out.push(`#### ${subSectionMatch[1].trim()}`); + continue; + } + const boldMethodMatch = line.match(/^#\s+\*\*([^*]+)\*\*\s*$/); if (!boldMethodMatch) { out.push(line); @@ -102,7 +129,7 @@ function normalizeHeadings(content) { } const method = boldMethodMatch[1].trim(); - out.push(`### ${method}`); + out.push(`## ${method}`); const nextLine = lines[i + 1] ?? ''; const nextNextLine = lines[i + 2] ?? ''; @@ -116,27 +143,764 @@ function normalizeHeadings(content) { result = out.join('\n'); - // Ensure any existing method anchor after ### heading is exactly one blank line then anchor. + // Ensure any existing method anchor after ## heading is exactly one blank line then anchor. result = result.replace( - /^###\s+([A-Za-z0-9_]+)\s*\n(?:\n)?(<\/a>)?/gm, - (_, method) => `### ${method}\n\n\n`, + /^##\s+([A-Za-z0-9_]+)\s*\n(?:\n)?(<\/a>)?/gm, + (_, method) => `## ${method}\n\n\n`, ); return result; } +/** + * Extract the Kubernetes resource name from an API method name. + * e.g. "createNamespacedConfigMap" -> "ConfigMap" + * "connectGetNamespacedPodExec" -> "Pod" + * "deleteCollectionNamespacedPod" -> "Pod" + * "listPodForAllNamespaces" -> "Pod" + */ +function extractResource(method) { + // connect methods: connectVerbNamespacedResource... or connectVerbResource... + if (method.startsWith('connect')) { + const withoutConnect = method.replace(/^connect[A-Z][a-z]+/, ''); + const withoutNs = withoutConnect.replace(/^Namespaced/, ''); + // Match longest known resource prefix + for (const res of ['Pod', 'Service', 'Node']) { + if (withoutNs.startsWith(res)) return res; + } + return withoutNs; + } + + // Standard CRUD verbs + const verbMatch = method.match(/^(create|deleteCollection|delete|list|patch|read|replace|get)(.*)/); + if (!verbMatch) return method; + + let rest = verbMatch[2]; + rest = rest.replace(/^Namespaced/, ''); + rest = rest.replace(/ForAllNamespaces$/, ''); + + // Map sub-resources to their parent resource + const subResourceMap = [ + // Order matters: longer matches first + ['PodBinding', 'Pod'], + ['PodEviction', 'Pod'], + ['PodEphemeralcontainers', 'Pod'], + ['PodResize', 'Pod'], + ['PodStatus', 'Pod'], + ['PodLog', 'Pod'], + ['PodTemplate', 'PodTemplate'], // PodTemplate is its own resource, not a Pod sub-resource + ['ServiceAccountToken', 'ServiceAccount'], + ['ServiceAccount', 'ServiceAccount'], // before Service + ['NamespaceFinalize', 'Namespace'], + ['ComponentStatus', 'ComponentStatus'], // not a sub-resource of Component + ]; + + for (const [suffix, resource] of subResourceMap) { + if (rest === suffix) return resource; + } + + // Generic sub-resource pattern: FooStatus -> Foo, FooScale -> Foo + const subResourceSuffix = rest.match(/^(.+?)(Status|Scale)$/); + if (subResourceSuffix) { + return subResourceSuffix[1]; + } + + return rest; +} + +/** Verb priority for ordering methods within a resource group. */ +function methodSortKey(method) { + const order = [ + 'create', 'read', 'list', 'patch', 'replace', 'delete', 'deleteCollection', 'connect', + ]; + + for (let i = 0; i < order.length; i++) { + if (method.startsWith(order[i])) { + // Sub-sort: plain resource first, then sub-resources (Status, Scale, Log, etc.) + const isSubResource = /(?:Status|Scale|Log|Binding|Eviction|Ephemeralcontainers|Resize|Token|Finalize|Proxy|Attach|Exec|Portforward)/.test(method); + const isForAllNamespaces = method.includes('ForAllNamespaces'); + const subPriority = isSubResource ? 1 : isForAllNamespaces ? 0.5 : 0; + return i + subPriority; + } + } + return order.length; +} + +/** Human-readable label for a resource group. */ +function resourceLabel(resource) { + // Insert spaces before capitals: PersistentVolumeClaim -> Persistent Volume Claim + return resource.replace(/([a-z])([A-Z])/g, '$1 $2'); +} + +/** + * Group methods by resource and rewrite the markdown with resource-level headings. + * + * Transforms: + * ## methodName -> ## Resource + * #### Example ### methodName + * #### Example + * + * Also rebuilds the summary table grouped by resource. + */ +function groupByResource(content) { + const lines = content.split('\n'); + + // 1. Split into preamble (everything before first ## method) and method blocks. + let preambleEnd = -1; + const methodBlocks = []; // { name, lines, resource } + + for (let i = 0; i < lines.length; i++) { + const match = lines[i].match(/^## ([A-Za-z0-9_]+)\s*$/); + if (match) { + if (preambleEnd === -1) preambleEnd = i; + + // Find the end of this method block (next ## or EOF). + let end = lines.length; + for (let j = i + 1; j < lines.length; j++) { + if (/^## [A-Za-z0-9_]+\s*$/.test(lines[j])) { + end = j; + break; + } + } + + const name = match[1]; + methodBlocks.push({ + name, + resource: extractResource(name), + lines: lines.slice(i, end), + }); + + i = end - 1; // -1 because loop will i++ + } + } + + // If no method blocks found, return as-is (non-API doc). + if (methodBlocks.length === 0) return content; + + const preambleLines = lines.slice(0, preambleEnd); + + // 2. Group by resource. + const resourceOrder = []; + const resourceGroups = new Map(); + + for (const block of methodBlocks) { + if (!resourceGroups.has(block.resource)) { + resourceOrder.push(block.resource); + resourceGroups.set(block.resource, []); + } + resourceGroups.get(block.resource).push(block); + } + + // Sort methods within each group by verb priority. + for (const blocks of resourceGroups.values()) { + blocks.sort((a, b) => methodSortKey(a.name) - methodSortKey(b.name)); + } + + // 3. Rebuild the summary table grouped by resource. + // Extract table rows from preamble (lines matching [**methodName**](link) | ...). + const tableRowsByMethod = new Map(); + const tableHeaderLines = []; + let inTable = false; + + for (const line of preambleLines) { + if (line.startsWith('[**') && line.includes('|')) { + const nameMatch = line.match(/\[\*\*(\w+)\*\*\]/); + if (nameMatch) { + tableRowsByMethod.set(nameMatch[1], line); + inTable = true; + } + } else if (inTable && line.match(/^-{3,}/)) { + // table separator line — skip, we'll regenerate + } else if (line.startsWith('Method |') || line.startsWith('Method|')) { + tableHeaderLines.push(line); + } else if (line.match(/^-+\s*\|/)) { + tableHeaderLines.push(line); + } + } + + // Extract descriptions from method blocks (the first non-empty text line after the > signature). + const descByMethod = new Map(); + for (const block of methodBlocks) { + let pastSignature = false; + for (const line of block.lines) { + if (line.startsWith('> ')) { + pastSignature = true; + continue; + } + if (pastSignature && line.trim() !== '') { + // Stop at sub-sections — the description is before any #### heading + if (line.startsWith('#')) break; + descByMethod.set(block.name, line.trim()); + break; + } + } + } + + // Build new preamble: everything before the table, then grouped table. + const newPreambleLines = []; + let seenTable = false; + let skippingOldTable = false; + + for (const line of preambleLines) { + // Detect the start of the old table (header line) + if (!seenTable && (line.startsWith('Method |') || line.startsWith('Method|'))) { + skippingOldTable = true; + seenTable = true; + continue; + } + + // Skip the separator line right after table header + if (skippingOldTable && line.match(/^-+\s*\|/)) { + continue; + } + + // Old table rows — skip and emit grouped table on first encounter + if (line.startsWith('[**') && line.includes('|')) { + if (skippingOldTable) { + skippingOldTable = false; + // Insert grouped table here + for (const resource of resourceOrder) { + const label = resourceLabel(resource); + newPreambleLines.push(''); + newPreambleLines.push(`### ${label}`); + newPreambleLines.push(''); + newPreambleLines.push('Method | HTTP request | Description'); + newPreambleLines.push('------------- | ------------- | -------------'); + const blocks = resourceGroups.get(resource); + for (const block of blocks) { + let row = tableRowsByMethod.get(block.name); + if (row) { + // Inject description into the table row if the last column is empty + const desc = descByMethod.get(block.name); + if (desc && row.match(/\|\s*$/)) { + row = row.replace(/\|\s*$/, `| ${desc}`); + } + newPreambleLines.push(row); + } + } + } + newPreambleLines.push(''); + } + continue; + } + + newPreambleLines.push(line); + } + + // 4. Rebuild method sections with resource group headings. + // ## Resource -> ### method, #### sub -> #### sub (keep), but we also need + // to demote: ## method -> ### method, #### sub -> ##### sub + const outputLines = [...newPreambleLines]; + + for (const resource of resourceOrder) { + const label = resourceLabel(resource); + const blocks = resourceGroups.get(resource); + + outputLines.push(''); + outputLines.push(`## ${label}`); + outputLines.push(''); + + for (const block of blocks) { + for (const line of block.lines) { + // Demote ## method -> ### method + if (/^## [A-Za-z0-9_]+\s*$/.test(line)) { + outputLines.push(line.replace(/^## /, '### ')); + } + // Demote #### sub-section -> ##### sub-section + else if (/^#### /.test(line)) { + outputLines.push(line.replace(/^#### /, '##### ')); + } + else { + outputLines.push(line); + } + } + } + } + + return outputLines.join('\n'); +} + function fixImports(content) { return content .replace(/from\s+''/g, "from '@kubernetes/client-node'") .replace(/from\s+\"\"/g, "from '@kubernetes/client-node'"); } +const MODEL_GROUP_MAP = { + 'core': /^V1(Pod|Service|Node|Namespace|ConfigMap|Secret|Endpoint|Event|Binding|Component|LimitRange|PersistentVolume|ReplicationController|ResourceQuota|PodTemplate|ServiceAccount|API)/, + 'workloads': /^V1(Deployment|StatefulSet|DaemonSet|ReplicaSet|ControllerRevision|Job|CronJob|HorizontalPodAutoscaler|Scale)/, + 'networking': /^V1(Ingress|NetworkPolicy|EndpointSlice|IPAddress|ServiceCIDR)/, + 'security': /^V1(ClusterRole|Role|CertificateSigningRequest|TokenReview|SubjectAccessReview|SelfSubjectAccessReview|SelfSubjectRulesReview|LocalSubjectAccessReview|TokenRequest)/, + 'configuration-storage': /^V1(StorageClass|VolumeAttachment|CSI|Lease|FlowSchema|PriorityLevelConfiguration|PodDisruptionBudget)/, + 'cluster': /^V1(CustomResourceDefinition|MutatingWebhookConfiguration|ValidatingWebhookConfiguration|ValidatingAdmissionPolicy|PriorityClass|Scheduling|Admission)/, +}; + +function resolveModelPage(typeName) { + const modelsDir = resolve(__dirname, '../../src/gen/models'); + if (!existsSync(join(modelsDir, `${typeName}.ts`))) return null; + + for (const [slug, pattern] of Object.entries(MODEL_GROUP_MAP)) { + if (pattern.test(typeName)) return slug; + } + return 'other'; +} + +/** Max optional top-level params to keep in generated examples. */ +const MAX_OPTIONAL_PARAMS = 3; +/** Examples longer than this (after truncation) get wrapped in
. */ +const COLLAPSE_THRESHOLD = 40; + +/** + * Truncate bloated generated code examples and optionally collapse them. + * + * 1. For each ```typescript code block inside a method section (## heading): + * a. Find the `body: { ... }` object literal and replace it with a + * one-line placeholder that links to the model type. + * b. Keep all required top-level request fields (no "(optional)" comment) + * plus the first MAX_OPTIONAL_PARAMS optional ones, drop the rest. + * 2. Wrap the example in a
block if the result exceeds + * COLLAPSE_THRESHOLD lines. + */ +function truncateExamples(content) { + // Split content into method sections (## headings). + // Process each section to truncate bloated examples. + const lines = content.split('\n'); + const sections = []; + let current = []; + + for (const line of lines) { + if (line.startsWith('## ') && current.length > 0) { + sections.push(current.join('\n')); + current = []; + } + current.push(line); + } + if (current.length > 0) sections.push(current.join('\n')); + + const processed = sections.map(section => { + if (!section.startsWith('## ')) return section; + + // Find the body param type from the parameter table. + const bodyTypeMatch = section.match( + /\*\*body\*\*\s*\|\s*(?:\*\*)?\[?\*?\*?(V\d\w+)\b/, + ); + const bodyType = bodyTypeMatch?.[1] ?? null; + const bodyModelPage = bodyType ? resolveModelPage(bodyType) : null; + const bodyLink = bodyModelPage + ? `See ${bodyType}: /models/${bodyModelPage}#${bodyType.toLowerCase()}` + : bodyType + ? `See ${bodyType} type definition` + : 'See type definition in parameter table'; + + // Process code blocks inside this section. + return section.replace( + /```typescript\n([\s\S]*?)```/g, + (codeBlock, code) => { + let codeLines = code.split('\n'); + + // --- Step 1: Truncate body: { ... } --- + codeLines = truncateBodyLiteral(codeLines, bodyLink); + + // --- Step 2: Trim optional params --- + codeLines = trimOptionalParams(codeLines); + + const trimmedCode = codeLines.join('\n'); + const lineCount = codeLines.length; + + // --- Step 3: Collapse if still long --- + if (lineCount > COLLAPSE_THRESHOLD) { + return `
\nExample\n\n\`\`\`typescript\n${trimmedCode}\`\`\`\n\n
`; + } + return `\`\`\`typescript\n${trimmedCode}\`\`\``; + }, + ); + }); + + return processed.join('\n'); +} + +/** + * Replace `body: { ...deeply nested... }` with a single-line placeholder. + */ +function truncateBodyLiteral(lines, bodyLink) { + const result = []; + let i = 0; + while (i < lines.length) { + const line = lines[i]; + + // Match `body: {` at request-field indent (2-6 leading spaces). + if (/^\s{2,6}body:\s*\{/.test(line)) { + // Track brace depth to find the matching close. + let depth = 0; + for (let j = i; j < lines.length; j++) { + for (const ch of lines[j]) { + if (ch === '{') depth++; + if (ch === '}') depth--; + } + if (depth <= 0) { + // Extract indent from the original line. + const indent = line.match(/^(\s*)/)[1]; + result.push(`${indent}body: { /* ${bodyLink} */ },`); + i = j + 1; + break; + } + } + continue; + } + result.push(line); + i++; + } + return result; +} + +/** + * Keep all required params + first MAX_OPTIONAL_PARAMS optional ones. + * Optional params are identified by a preceding comment containing "(optional)". + */ +function trimOptionalParams(lines) { + // Find the request object region: `const request: ...Request = {` ... `};` + const reqStart = lines.findIndex(l => /^\s*const request:.*=\s*\{/.test(l)); + if (reqStart === -1) return lines; + + // Find matching `};` + let depth = 0; + let reqEnd = -1; + for (let i = reqStart; i < lines.length; i++) { + for (const ch of lines[i]) { + if (ch === '{') depth++; + if (ch === '}') depth--; + } + if (depth <= 0) { reqEnd = i; break; } + } + if (reqEnd === -1) return lines; + + // Parse fields inside the request object. + // Each field is optionally preceded by a comment line containing "(optional)". + // Field lines look like: ` name: "value",` or ` body: { /* ... */ },` + const before = lines.slice(0, reqStart + 1); + const inner = lines.slice(reqStart + 1, reqEnd); + const after = lines.slice(reqEnd); + + const fields = []; // { commentLines, fieldLines, isOptional } + let currentComment = []; + let currentField = []; + let isOpt = false; + let fieldDepth = 0; + + for (const line of inner) { + const trimmed = line.trim(); + + // Comment line + if (trimmed.startsWith('//')) { + // If we were accumulating a field, flush it. + if (currentField.length > 0) { + fields.push({ commentLines: currentComment, fieldLines: currentField, isOptional: isOpt }); + currentComment = []; + currentField = []; + isOpt = false; + } + currentComment.push(line); + if (trimmed.includes('(optional)')) isOpt = true; + continue; + } + + // Blank line between fields + if (trimmed === '' && fieldDepth === 0) { + if (currentField.length > 0) { + fields.push({ commentLines: currentComment, fieldLines: currentField, isOptional: isOpt }); + currentComment = []; + currentField = []; + isOpt = false; + } + // Keep blank lines as separators (will be re-added) + continue; + } + + // Track depth for multi-line field values + for (const ch of line) { + if (ch === '{' || ch === '[') fieldDepth++; + if (ch === '}' || ch === ']') fieldDepth--; + } + currentField.push(line); + + if (fieldDepth <= 0) { + fields.push({ commentLines: currentComment, fieldLines: currentField, isOptional: isOpt }); + currentComment = []; + currentField = []; + isOpt = false; + fieldDepth = 0; + } + } + // Flush last + if (currentField.length > 0 || currentComment.length > 0) { + fields.push({ commentLines: currentComment, fieldLines: currentField, isOptional: isOpt }); + } + + // Keep required fields + first N optional + const kept = []; + let optionalKept = 0; + let droppedOptional = 0; + for (const f of fields) { + if (!f.isOptional) { + kept.push(f); + } else if (optionalKept < MAX_OPTIONAL_PARAMS) { + kept.push(f); + optionalKept++; + } else { + droppedOptional++; + } + } + + // Rebuild + const newInner = []; + for (const f of kept) { + newInner.push(...f.commentLines, ...f.fieldLines); + } + if (droppedOptional > 0) { + // Determine indent from first field + const indent = kept[0]?.fieldLines[0]?.match(/^(\s*)/)?.[1] ?? ' '; + newInner.push(`${indent}// ...${droppedOptional} more optional parameter(s)`); + } + + return [...before, ...newInner, ...after]; +} + + +/** + * Strip per-method boilerplate sections that are identical across all methods. + * Removes: Authorization, HTTP request headers, HTTP response details. + * These are replaced by a single shared section injected at the API-page level. + */ +function stripBoilerplate(content) { + // Remove #### Authorization ... #### next-section + let result = content.replace( + /^#{3,5} Authorization\n+\[BearerToken\]\(#authorization\)\n+/gm, + '', + ); + + // Remove #### HTTP request headers ... #### next-section + result = result.replace( + /^#{3,5} HTTP request headers\n+(?:\s*-\s+\*\*(?:Content-Type|Accept)\*\*:.*\n)+\n*/gm, + '', + ); + + // Remove #### HTTP response details ... (table until next heading or blank-line-then-heading) + result = result.replace( + /^#{3,5} HTTP response details\n+\|[^\n]*\n\|[-| ]*\n(?:\*\*\d+\*\*[^\n]*\n)*\n*/gm, + '', + ); + + return result; +} + +// Parameters that appear across many API methods and should link to a central reference page. +// Threshold: appears in 100+ methods. 'name' and 'namespace' excluded (context-specific descriptions). +const COMMON_PARAM_NAMES = new Set([ + 'pretty', 'dryRun', 'fieldManager', 'fieldValidation', + 'labelSelector', 'fieldSelector', '_continue', 'limit', + 'resourceVersion', 'resourceVersionMatch', 'timeoutSeconds', + 'sendInitialEvents', 'gracePeriodSeconds', 'orphanDependents', + 'propagationPolicy', 'ignoreStoreReadErrorWithClusterBreakingPotential', + 'force', 'allowWatchBookmarks', 'watch', +]); + +/** + * Collect full (pre-truncation) descriptions for common parameters from raw source files. + * Returns a Map. + */ +function collectCommonParams(docsDir) { + const params = new Map(); + for (const file of readdirSync(docsDir).filter(f => extname(f) === '.md')) { + const content = readFileSync(join(docsDir, file), 'utf8'); + for (const m of content.matchAll(/^ \*\*(\w+)\*\* \| \[\*\*(\w+)\*\*\] \| (.+?) \| (.+)$/gm)) { + const [, name, type, desc] = m; + if (!COMMON_PARAM_NAMES.has(name)) continue; + // Keep the longest description variant + if (!params.has(name) || desc.length > params.get(name).description.length) { + params.set(name, { type, description: desc }); + } + } + } + return params; +} + +/** + * Decode HTML entities that the OpenAPI generator emits. + */ +function decodeHtmlEntities(str) { + return str + .replace(/`/g, '`') + .replace(/=/g, '=') + .replace(/"/g, '"') + .replace(/\\""/g, '"') + .replace(/\\"/g, '"') + .replace(/&/g, '&') + .replace(/'/g, "'") + .replace(/\\'/g, "'") + .replace(/\\_"/g, '"') + .replace(/\\&/g, '&'); +} + +/** + * Generate the common-parameters.md reference page. + */ +function generateCommonParamsPage(outputDir, commonParams) { + // Order params by logical grouping + const order = [ + // Read / list + 'pretty', 'labelSelector', 'fieldSelector', 'limit', '_continue', + 'resourceVersion', 'resourceVersionMatch', 'timeoutSeconds', + 'watch', 'allowWatchBookmarks', 'sendInitialEvents', + // Write + 'dryRun', 'fieldManager', 'fieldValidation', 'force', + // Delete + 'gracePeriodSeconds', 'orphanDependents', 'propagationPolicy', + 'ignoreStoreReadErrorWithClusterBreakingPotential', + ]; + + const lines = [ + '---', + 'id: common-parameters', + 'title: Common Parameters', + 'sidebar_label: Common Parameters', + 'sidebar_position: 0', + '---', + '', + '# Common Parameters', + '', + 'These parameters appear across many Kubernetes API methods. Individual method pages link here for the full description.', + '', + ]; + + for (const name of order) { + const param = commonParams.get(name); + if (!param) continue; + const displayName = name === '_continue' ? 'continue' : name; + const decoded = decodeHtmlEntities(param.description); + lines.push(`## ${displayName} {#${name}}`); + lines.push(''); + lines.push(`**Type:** \`${param.type}\``); + lines.push(''); + lines.push(decoded); + lines.push(''); + } + + writeFileSync(join(outputDir, 'common-parameters.md'), lines.join('\n'), 'utf8'); +} + +/** + * Truncate overly verbose parameter descriptions in markdown tables. + * Keeps the first sentence (up to ~120 chars) and drops the rest. + * Also links common parameter names to the central reference page. + */ +function truncateParamDescriptions(content) { + return content.replace( + /^(\s*)\*\*(\w+)\*\*(\s*\|\s*\[?\*?\*?\w+\*?\*?\]?\s*\|\s*)(.+?)(\s*\|\s*\(optional\).*$)/gm, + (full, indent, paramName, middle, desc, suffix) => { + const isCommon = COMMON_PARAM_NAMES.has(paramName); + // Link common params to the reference page + const nameCol = isCommon + ? `${indent}[**${paramName}**](/api-reference/common-parameters#${paramName})${middle}` + : `${indent}**${paramName}**${middle}`; + + // For common params, replace description with a short version + link + if (isCommon) { + // Keep first sentence or truncate, then append link + let shortDesc = desc; + if (desc.length > 150) { + const sentenceEnd = desc.match(/^(.{40,140}?[.])\s/); + shortDesc = sentenceEnd ? sentenceEnd[1] : desc.slice(0, 120) + '...'; + } + return `${nameCol}${shortDesc} [More info](/api-reference/common-parameters#${paramName})${suffix}`; + } + + if (desc.length <= 150) return `${nameCol}${desc}${suffix}`; + // Find first sentence boundary + const sentenceEnd = desc.match(/^(.{40,140}?[.])\s/); + if (sentenceEnd) { + return `${nameCol}${sentenceEnd[1]}${suffix}`; + } + // No sentence boundary — hard truncate at 120 + return `${nameCol}${desc.slice(0, 120)}...${suffix}`; + }, + ); +} + +/** Minimal body examples for common resource types. */ +const MINIMAL_BODIES = { + V1Pod: `{ apiVersion: "v1", kind: "Pod", metadata: { name: "example" }, spec: { containers: [{ name: "app", image: "nginx" }] } }`, + V1Namespace: `{ apiVersion: "v1", kind: "Namespace", metadata: { name: "example" } }`, + V1Service: `{ apiVersion: "v1", kind: "Service", metadata: { name: "example" }, spec: { selector: { app: "example" }, ports: [{ port: 80 }] } }`, + V1ConfigMap: `{ apiVersion: "v1", kind: "ConfigMap", metadata: { name: "example" }, data: { key: "value" } }`, + V1Secret: `{ apiVersion: "v1", kind: "Secret", metadata: { name: "example" }, stringData: { password: "secret" } }`, + V1Deployment: `{ apiVersion: "apps/v1", kind: "Deployment", metadata: { name: "example" }, spec: { replicas: 1, selector: { matchLabels: { app: "example" } }, template: { metadata: { labels: { app: "example" } }, spec: { containers: [{ name: "app", image: "nginx" }] } } } }`, + V1StatefulSet: `{ apiVersion: "apps/v1", kind: "StatefulSet", metadata: { name: "example" }, spec: { replicas: 1, selector: { matchLabels: { app: "example" } }, serviceName: "example", template: { metadata: { labels: { app: "example" } }, spec: { containers: [{ name: "app", image: "nginx" }] } } } }`, + V1DaemonSet: `{ apiVersion: "apps/v1", kind: "DaemonSet", metadata: { name: "example" }, spec: { selector: { matchLabels: { app: "example" } }, template: { metadata: { labels: { app: "example" } }, spec: { containers: [{ name: "app", image: "nginx" }] } } } }`, + V1Job: `{ apiVersion: "batch/v1", kind: "Job", metadata: { name: "example" }, spec: { template: { spec: { containers: [{ name: "job", image: "busybox", command: ["echo", "hello"] }], restartPolicy: "Never" } } } }`, + V1CronJob: `{ apiVersion: "batch/v1", kind: "CronJob", metadata: { name: "example" }, spec: { schedule: "*/5 * * * *", jobTemplate: { spec: { template: { spec: { containers: [{ name: "job", image: "busybox", command: ["echo", "hello"] }], restartPolicy: "Never" } } } } } }`, + V1Ingress: `{ apiVersion: "networking.k8s.io/v1", kind: "Ingress", metadata: { name: "example" }, spec: { rules: [{ host: "example.com", http: { paths: [{ path: "/", pathType: "Prefix", backend: { service: { name: "example", port: { number: 80 } } } }] } }] } }`, +}; + +/** + * Replace generic body placeholder comments with minimal realistic examples + * for well-known Kubernetes resource types. + */ +function inlineMinimalBodies(content) { + return content.replace( + /body: \{ \/\* See (V\d\w+): ([^\*]+) \*\/ \}/g, + (full, typeName, modelLink) => { + const minimal = MINIMAL_BODIES[typeName]; + if (minimal) { + return `body: ${minimal}, // See full type: ${modelLink.trim()}`; + } + return full; + }, + ); +} + + function cleanupContent(content) { let result = content; + // Decode HTML entities left by the OpenAPI code generator. + result = result.replace(/\\?"/g, '"'); + result = result.replace(/\\?'/g, "'"); + result = result.replace(/\\?&/g, '&'); + result = result.replace(/\\?</g, '<'); + result = result.replace(/\\?>/g, '>'); + result = result.replace(/`/g, '`'); + result = result.replace(/=/g, '='); + result = result.replace(/&#x([0-9a-fA-F]+);/g, (_, hex) => String.fromCharCode(parseInt(hex, 16))); + // Footer cleanup result = result.replace(/^\[\[Back to top\]\].*$/gm, ''); + result = result.replace( + /^((?:>\s+)?)(V\d(?:alpha\d|beta\d)?[A-Z]\w+)((?:\s+\w+\(.*\))?)$/gm, + (full, prefix, typeName, methodSig) => { + const page = resolveModelPage(typeName); + if (!page) return full; + const link = `/models/${page}#${typeName.toLowerCase()}`; + if (methodSig) { + return `${prefix}[${typeName}](${link})${methodSig}`; + } + return `${prefix}[${typeName}](${link})`; + }, + ); + result = result.replace( + /\*\*(V\d(?:alpha\d|beta\d)?[A-Z]\w+)\*\*/g, + (full, typeName) => { + const page = resolveModelPage(typeName); + if (!page) return full; + return `**[${typeName}](/models/${page}#${typeName.toLowerCase()})**`; + }, + ); + // Also link types in parameter table body column: **body** | **V1Pod** | ... + result = result.replace( + /\*\*(V\d(?:alpha\d|beta\d)?[A-Z]\w+)\*\*/g, + (full, typeName) => `**[${typeName}](${K8S_SOURCE_BASE}/${typeName}.ts)**`, + ); + // Unbold model names in return signatures and return type sections result = result.replace(/^>\s+\*\*([^*]+)\*\*(\s+.+)$/gm, '> $1$2'); result = result.replace(/^\*\*([^*]+)\*\*$/gm, '$1'); @@ -159,6 +923,7 @@ function makeFrontmatter({ id, title, sidebarLabel, sidebarPosition }) { `title: ${title}`, `sidebar_label: ${sidebarLabel}`, `sidebar_position: ${sidebarPosition}`, + 'toc_max_heading_level: 2', '---', '', ].join('\n'); @@ -172,6 +937,11 @@ export function transformMarkdown(content, { className, sidebarPosition, apiGrou transformed = normalizeHeadings(transformed); transformed = rewriteLinks(transformed, apiGroupMap, warnings); transformed = fixImports(transformed); + transformed = truncateExamples(transformed); + transformed = inlineMinimalBodies(transformed); + transformed = stripBoilerplate(transformed); + transformed = truncateParamDescriptions(transformed); + transformed = groupByResource(transformed); transformed = cleanupContent(transformed); const frontmatter = makeFrontmatter({ @@ -221,20 +991,282 @@ function writeCategoryFiles(outputRoot) { }); } -function validateOutputs(outputRoot, warnings) { - const mdFiles = []; +/** Size threshold in bytes above which a file gets split by resource group. */ +const SPLIT_THRESHOLD = 500 * 1024; + +/** + * Convert a resource label like "Persistent Volume Claim" to a URL-safe slug. + */ +function resourceSlug(label) { + return label.replace(/\s+/g, '-').toLowerCase(); +} + +/** + * Split large API reference files into per-resource pages. + * + * For a file like CoreV1Api.md (2MB), creates: + * CoreV1Api/index.md — summary table with links + * CoreV1Api/pod.md — Pod resource methods + * CoreV1Api/service.md — Service resource methods + * ... + * + * Then updates all cross-references in other files. + */ +function splitLargeFiles(outputRoot, warnings) { + const splitResults = []; for (const slug of Object.values(CATEGORY_SLUG_BY_NAME)) { - const dir = join(outputRoot, slug); - let files = []; + const categoryDir = join(outputRoot, slug); + let files; try { - files = readdirSync(dir).filter((f) => extname(f) === '.md'); + files = readdirSync(categoryDir).filter((f) => extname(f) === '.md'); } catch { continue; } for (const file of files) { - mdFiles.push(join(dir, file)); + const filePath = join(categoryDir, file); + const stat = statSync(filePath); + if (stat.size < SPLIT_THRESHOLD) continue; + + const className = file.replace(/\.md$/, ''); + const content = readFileSync(filePath, 'utf8'); + const result = splitSingleFile(content, className, categoryDir, slug, warnings); + if (result) { + splitResults.push(result); + // Remove the original monolithic file. + rmSync(filePath); + } + } + } + + // Rewrite cross-references in ALL files to point to split pages. + if (splitResults.length > 0) { + rewriteSplitReferences(outputRoot, splitResults); + // Also rewrite versioned docs. + const versionedDir = resolve(outputRoot, '../../versioned_docs'); + try { + for (const versionEntry of readdirSync(versionedDir, { withFileTypes: true })) { + if (versionEntry.isDirectory()) { + const versionedApiRef = join(versionedDir, versionEntry.name, 'api-reference'); + try { + rewriteSplitReferences(versionedApiRef, splitResults); + } catch { + // No api-reference in this version, skip. + } + } + } + } catch { + // No versioned_docs dir, skip. + } + } + + return splitResults; +} + +function splitSingleFile(content, className, categoryDir, categorySlug, warnings) { + const lines = content.split('\n'); + + // Extract frontmatter. + let frontmatterEnd = 0; + if (lines[0] === '---') { + for (let i = 1; i < lines.length; i++) { + if (lines[i] === '---') { + frontmatterEnd = i + 1; + break; + } + } + } + + // Find preamble end and resource sections. + // Preamble = everything from after frontmatter to the first ## Resource heading. + // Resource sections start with ^## ResourceLabel$ + const sections = []; // { label, slug, startLine, endLine } + let preambleEnd = lines.length; + + for (let i = frontmatterEnd; i < lines.length; i++) { + const match = lines[i].match(/^## (.+)$/); + if (match) { + if (sections.length === 0) { + preambleEnd = i; + } else { + sections[sections.length - 1].endLine = i; + } + const label = match[1]; + sections.push({ label, slug: resourceSlug(label), startLine: i, endLine: lines.length }); + } + } + + if (sections.length < 2) { + warnings.push(`${className}: only ${sections.length} sections, skipping split`); + return null; + } + + // Create subdirectory. + const subDir = join(categoryDir, className); + mkdirSync(subDir, { recursive: true }); + + // Write _category_.json for Docusaurus sidebar. + // Extract sidebar_position from frontmatter. + const posMatch = content.match(/sidebar_position:\s*(\d+)/); + const sidebarPosition = posMatch ? parseInt(posMatch[1], 10) : 1; + + writeFileSync( + join(subDir, '_category_.json'), + JSON.stringify({ label: className, position: sidebarPosition }, null, 2) + '\n', + 'utf8', + ); + + // Build the index page with grouped summary tables. + // Take preamble lines (title, "All URIs..." text, summary tables). + const preambleContent = lines.slice(frontmatterEnd, preambleEnd); + + // Rewrite summary table links: #methodName -> ./resource-slug#methodName + const methodToSlug = new Map(); + for (const section of sections) { + for (let i = section.startLine; i < section.endLine; i++) { + const methodMatch = lines[i].match(/^### ([a-zA-Z0-9_]+)\s*$/); + if (methodMatch) { + methodToSlug.set(methodMatch[1], section.slug); + } + } + } + + const rewrittenPreamble = preambleContent.map((line) => { + // Rewrite method links in summary table: #method -> ./slug#method + return line.replace( + new RegExp(`(${className}#)(\\w+)`, 'g'), + (full, prefix, method) => { + const slug = methodToSlug.get(method); + if (slug) return `${className}/${slug}#${method}`; + return full; + }, + ); + }); + + const indexFrontmatter = [ + '---', + `id: ${className}`, + `title: ${className}`, + `sidebar_label: ${className}`, + 'toc_max_heading_level: 3', + '---', + '', + ].join('\n'); + + writeFileSync( + join(subDir, 'index.md'), + indexFrontmatter + rewrittenPreamble.join('\n') + '\n', + 'utf8', + ); + + // Write individual resource pages. + for (let si = 0; si < sections.length; si++) { + const section = sections[si]; + const sectionLines = lines.slice(section.startLine, section.endLine); + + // Promote headings back up: ## Resource -> # Resource, ### method -> ## method, ##### -> #### + const promotedLines = sectionLines.map((line) => { + if (/^## /.test(line)) return line.replace(/^## /, '# '); + if (/^### /.test(line)) return line.replace(/^### /, '## '); + if (/^##### /.test(line)) return line.replace(/^##### /, '#### '); + return line; + }); + + const pageFrontmatter = [ + '---', + `id: ${section.slug}`, + `title: "${className}: ${section.label}"`, + `sidebar_label: ${section.label}`, + `sidebar_position: ${si + 1}`, + 'toc_max_heading_level: 2', + '---', + '', + ].join('\n'); + + writeFileSync( + join(subDir, `${section.slug}.md`), + pageFrontmatter + promotedLines.join('\n') + '\n', + 'utf8', + ); + } + + return { + className, + categorySlug, + methods: methodToSlug, // Map + }; +} + +/** + * Rewrite cross-references across ALL output files to point to split pages. + * e.g. /api-reference/core-resources/CoreV1Api#createNamespacedPod + * -> /api-reference/core-resources/CoreV1Api/pod#createNamespacedPod + */ +function rewriteSplitReferences(outputRoot, splitResults) { + // Build lookup: className -> Map + const lookup = new Map(); + for (const result of splitResults) { + lookup.set(result.className, { categorySlug: result.categorySlug, methods: result.methods }); + } + + // Walk all markdown files. + function walkDir(dir) { + for (const entry of readdirSync(dir, { withFileTypes: true })) { + const fullPath = join(dir, entry.name); + if (entry.isDirectory()) { + walkDir(fullPath); + } else if (entry.isFile() && extname(entry.name) === '.md') { + let content = readFileSync(fullPath, 'utf8'); + let changed = false; + + for (const [className, { categorySlug, methods }] of lookup) { + // Match links like /api-reference/slug/ClassName#method + const pattern = new RegExp( + `(/api-reference/${categorySlug}/${className})#(\\w+)`, + 'g', + ); + + content = content.replace(pattern, (full, base, method) => { + const resSlug = methods.get(method); + if (resSlug) { + changed = true; + return `${base}/${resSlug}#${method}`; + } + return full; + }); + } + + if (changed) { + writeFileSync(fullPath, content, 'utf8'); + } + } + } + } + + walkDir(outputRoot); +} + +function validateOutputs(outputRoot, warnings) { + const mdFiles = []; + + function collectMdFiles(dir) { + for (const entry of readdirSync(dir, { withFileTypes: true })) { + const fullPath = join(dir, entry.name); + if (entry.isDirectory()) { + collectMdFiles(fullPath); + } else if (entry.isFile() && extname(entry.name) === '.md') { + mdFiles.push(fullPath); + } + } + } + + for (const slug of Object.values(CATEGORY_SLUG_BY_NAME)) { + const dir = join(outputRoot, slug); + try { + collectMdFiles(dir); + } catch { + continue; } } @@ -267,16 +1299,24 @@ export function runTransform({ .filter((name) => extname(name) === '.md') .sort((a, b) => a.localeCompare(b)); + // Collect full common parameter descriptions before any truncation. + const commonParams = collectCommonParams(docsDir); + // Clean output tree for deterministic idempotent output. rmSync(outputDir, { recursive: true, force: true }); mkdirSync(outputDir, { recursive: true }); writeCategoryFiles(outputDir); + // Generate common parameters reference page. + generateCommonParamsPage(outputDir, commonParams); + for (const [categoryIndex, category] of CATEGORY_ORDER.entries()) { const slug = CATEGORY_SLUG_BY_NAME[category]; const classNames = (byCategory.get(category) ?? []).slice().sort((a, b) => a.localeCompare(b)); for (const className of classNames) { + if (SKIP_CLASSES.has(className)) continue; + const inputFileName = `${className}.md`; if (!inputFiles.includes(inputFileName)) { warnings.push(`Missing input markdown for ${className}`); @@ -305,7 +1345,7 @@ export function runTransform({ const mappedNames = new Set(Object.keys(apiGroupMap)); const unmappedInputs = inputFiles .map((f) => f.replace(/\.md$/, '')) - .filter((className) => !mappedNames.has(className)) + .filter((className) => !mappedNames.has(className) && !SKIP_CLASSES.has(className)) .sort((a, b) => a.localeCompare(b)); for (const className of unmappedInputs) { @@ -326,11 +1366,14 @@ export function runTransform({ writeFileSync(outputPath, transformed, 'utf8'); } + // Split large files into per-resource pages. + const splitResults = splitLargeFiles(outputDir, warnings); + const { fileCount, warningCount } = validateOutputs(outputDir, warnings); - return { fileCount, warningCount, outputDir: toPosixPath(outputDir) }; + return { fileCount, warningCount, splitCount: splitResults.length, outputDir: toPosixPath(outputDir) }; } if (process.argv[1] && resolve(process.argv[1]) === __filename) { const result = runTransform(); - console.log(`Transformed ${result.fileCount} files with ${result.warningCount} warnings`); + console.log(`Transformed ${result.fileCount} files (${result.splitCount} split) with ${result.warningCount} warnings`); } diff --git a/website/sidebars.ts b/website/sidebars.ts index 669d3ba9dad..842c5f9b4ef 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -14,7 +14,15 @@ const sidebars: SidebarsConfig = { type: 'category', label: 'Getting Started', collapsed: false, - items: ['intro'], + items: [ + 'intro', + { + type: 'category', + label: 'Examples', + link: { type: 'generated-index' }, + items: [{ type: 'autogenerated', dirName: 'examples' }], + }, + ], }, { type: 'category', @@ -35,7 +43,7 @@ const sidebars: SidebarsConfig = { label: 'Watching & Caching', link: { type: 'generated-index' }, items: [ - { type: 'autogenerated', dirName: 'sdk/watch' }, + { type: 'doc', id: 'sdk/watch/index', label: 'Watch' }, { type: 'autogenerated', dirName: 'sdk/informer' }, { type: 'autogenerated', dirName: 'sdk/cache' }, ], @@ -45,10 +53,10 @@ const sidebars: SidebarsConfig = { label: 'Pod Operations', link: { type: 'generated-index' }, items: [ - { type: 'autogenerated', dirName: 'sdk/exec' }, - { type: 'autogenerated', dirName: 'sdk/attach' }, - { type: 'autogenerated', dirName: 'sdk/portforward' }, - { type: 'autogenerated', dirName: 'sdk/cp' }, + { type: 'doc', id: 'sdk/exec/index', label: 'Exec' }, + { type: 'doc', id: 'sdk/attach/index', label: 'Attach' }, + { type: 'doc', id: 'sdk/portforward/index', label: 'PortForward' }, + { type: 'doc', id: 'sdk/cp/index', label: 'Cp' }, { type: 'autogenerated', dirName: 'sdk/log' }, ], }, @@ -66,9 +74,9 @@ const sidebars: SidebarsConfig = { label: 'Utilities', link: { type: 'generated-index' }, items: [ - { type: 'autogenerated', dirName: 'sdk/object' }, + { type: 'doc', id: 'sdk/object/index', label: 'KubernetesObjectApi' }, { type: 'autogenerated', dirName: 'sdk/patch' }, - { type: 'autogenerated', dirName: 'sdk/health' }, + { type: 'doc', id: 'sdk/health/index', label: 'Health' }, { type: 'autogenerated', dirName: 'sdk/middleware' }, { type: 'autogenerated', dirName: 'sdk/types' }, { type: 'autogenerated', dirName: 'sdk/yaml' }, @@ -83,6 +91,13 @@ const sidebars: SidebarsConfig = { link: { type: 'generated-index' }, items: [{ type: 'autogenerated', dirName: 'api-reference' }], }, + { + type: 'category', + label: 'API Models', + collapsed: true, + link: { type: 'generated-index' }, + items: [{ type: 'autogenerated', dirName: 'models' }], + }, ], }; diff --git a/website/src/pages/404.tsx b/website/src/pages/404.tsx new file mode 100644 index 00000000000..bd71ce58b4e --- /dev/null +++ b/website/src/pages/404.tsx @@ -0,0 +1,50 @@ +import React from 'react'; +import Layout from '@theme/Layout'; +import Link from '@docusaurus/Link'; + +export default function NotFound(): React.JSX.Element { + return ( + +
+

404

+

+ This page doesn't exist, but these might help: +

+
+ + Quick Start + + + Examples + + + API Reference + + + KubeConfig + +
+
+ + ); +} diff --git a/website/src/pages/index.module.css b/website/src/pages/index.module.css deleted file mode 100644 index 9f71a5da775..00000000000 --- a/website/src/pages/index.module.css +++ /dev/null @@ -1,23 +0,0 @@ -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - -.heroBanner { - padding: 4rem 0; - text-align: center; - position: relative; - overflow: hidden; -} - -@media screen and (max-width: 996px) { - .heroBanner { - padding: 2rem; - } -} - -.buttons { - display: flex; - align-items: center; - justify-content: center; -} diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx deleted file mode 100644 index f9055368085..00000000000 --- a/website/src/pages/index.tsx +++ /dev/null @@ -1,81 +0,0 @@ -import type { ReactNode } from 'react'; -import clsx from 'clsx'; -import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import Layout from '@theme/Layout'; -import Heading from '@theme/Heading'; - -import styles from './index.module.css'; - -function HomepageHeader() { - const { siteConfig } = useDocusaurusContext(); - return ( -
-
- - {siteConfig.title} - -

{siteConfig.tagline}

-
- - Get Started - - - GitHub - -
-
- npm install @kubernetes/client-node -
-
-
- ); -} - -export default function Home(): ReactNode { - const { siteConfig } = useDocusaurusContext(); - return ( - - -
-
-
-
-
-
- Type Safe -

- Written in TypeScript with full support for Kubernetes API objects and - types. -

-
-
-
-
- Node.js Optimized -

- Designed for server-side use with native support for KubeConfig and - Service Accounts. -

-
-
-
-
- Official Client -

- Maintained by the Kubernetes community as the standard JavaScript - implementation. -

-
-
-
-
-
-
- - ); -} diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationApi.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationApi.md deleted file mode 100644 index 7b767b754f2..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AdmissionregistrationApi -title: AdmissionregistrationApi -sidebar_label: AdmissionregistrationApi -sidebar_position: 1 ---- -# AdmissionregistrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/cluster/AdmissionregistrationApi#getAPIGroup) | **GET** /apis/admissionregistration.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1Api.md deleted file mode 100644 index 998daa88cab..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1Api.md +++ /dev/null @@ -1,3767 +0,0 @@ ---- -id: AdmissionregistrationV1Api -title: AdmissionregistrationV1Api -sidebar_label: AdmissionregistrationV1Api -sidebar_position: 3 ---- -# AdmissionregistrationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createMutatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**createValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**createValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**createValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#createValidatingWebhookConfiguration) | **POST** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**deleteCollectionMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**deleteCollectionValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**deleteCollectionValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**deleteCollectionValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteCollectionValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**deleteMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteMutatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**deleteValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**deleteValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**deleteValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#deleteValidatingWebhookConfiguration) | **DELETE** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1/ | -[**listMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | -[**listValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | -[**listValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | -[**listValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#listValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | -[**patchMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchMutatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**patchValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**patchValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**patchValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingAdmissionPolicyStatus) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**patchValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#patchValidatingWebhookConfiguration) | **PATCH** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**readMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readMutatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**readValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**readValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**readValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingAdmissionPolicyStatus) | **GET** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**readValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#readValidatingWebhookConfiguration) | **GET** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | -[**replaceMutatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceMutatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | -[**replaceValidatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | -[**replaceValidatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | -[**replaceValidatingAdmissionPolicyStatus**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingAdmissionPolicyStatus) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | -[**replaceValidatingWebhookConfiguration**](/docs/api-reference/cluster/AdmissionregistrationV1Api#replaceValidatingWebhookConfiguration) | **PUT** /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | - -### createMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfiguration createMutatingWebhookConfiguration(body) - -create a MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - reinvocationPolicy: "reinvocationPolicy_example", - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1MutatingWebhookConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicy createValidatingAdmissionPolicy(body) - -create a ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBinding createValidatingAdmissionPolicyBinding(body) - -create a ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - validationActions: [ - "validationActions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfiguration createValidatingWebhookConfiguration(body) - -create a ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingWebhookConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingWebhookConfiguration - - - -> V1Status deleteCollectionMutatingWebhookConfiguration() - -delete collection of MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionValidatingAdmissionPolicy - - - -> V1Status deleteCollectionValidatingAdmissionPolicy() - -delete collection of ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionValidatingAdmissionPolicyBinding - - - -> V1Status deleteCollectionValidatingAdmissionPolicyBinding() - -delete collection of ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionValidatingWebhookConfiguration - - - -> V1Status deleteCollectionValidatingWebhookConfiguration() - -delete collection of ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteMutatingWebhookConfiguration - - - -> V1Status deleteMutatingWebhookConfiguration() - -delete a MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteValidatingAdmissionPolicy - - - -> V1Status deleteValidatingAdmissionPolicy() - -delete a ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteValidatingAdmissionPolicyBinding - - - -> V1Status deleteValidatingAdmissionPolicyBinding() - -delete a ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteValidatingWebhookConfiguration - - - -> V1Status deleteValidatingWebhookConfiguration() - -delete a ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfigurationList listMutatingWebhookConfiguration() - -list or watch objects of kind MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfigurationList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicyList listValidatingAdmissionPolicy() - -list or watch objects of kind ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBindingList listValidatingAdmissionPolicyBinding() - -list or watch objects of kind ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfigurationList listValidatingWebhookConfiguration() - -list or watch objects of kind ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfigurationList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfiguration patchMutatingWebhookConfiguration(body) - -partially update the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicy(body) - -partially update the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBinding patchValidatingAdmissionPolicyBinding(body) - -partially update the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchValidatingAdmissionPolicyStatus - - - -> V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicyStatus(body) - -partially update status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfiguration patchValidatingWebhookConfiguration(body) - -partially update the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfiguration readMutatingWebhookConfiguration() - -read the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicy() - -read the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBinding readValidatingAdmissionPolicyBinding() - -read the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readValidatingAdmissionPolicyStatus - - - -> V1ValidatingAdmissionPolicy readValidatingAdmissionPolicyStatus() - -read status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfiguration readValidatingWebhookConfiguration() - -read the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceMutatingWebhookConfiguration - - - -> V1MutatingWebhookConfiguration replaceMutatingWebhookConfiguration(body) - -replace the specified MutatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest = { - // name of the MutatingWebhookConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - reinvocationPolicy: "reinvocationPolicy_example", - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1MutatingWebhookConfiguration**| | - **name** | [**string**] | name of the MutatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1MutatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceValidatingAdmissionPolicy - - - -> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicy(body) - -replace the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceValidatingAdmissionPolicyBinding - - - -> V1ValidatingAdmissionPolicyBinding replaceValidatingAdmissionPolicyBinding(body) - -replace the specified ValidatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest = { - // name of the ValidatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - validationActions: [ - "validationActions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceValidatingAdmissionPolicyStatus - - - -> V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicyStatus(body) - -replace status of the specified ValidatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest = { - // name of the ValidatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - auditAnnotations: [ - { - key: "key_example", - valueExpression: "valueExpression_example", - }, - ], - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - validations: [ - { - expression: "expression_example", - message: "message_example", - messageExpression: "messageExpression_example", - reason: "reason_example", - }, - ], - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - typeChecking: { - expressionWarnings: [ - { - fieldRef: "fieldRef_example", - warning: "warning_example", - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingAdmissionPolicyStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingAdmissionPolicy**| | - **name** | [**string**] | name of the ValidatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceValidatingWebhookConfiguration - - - -> V1ValidatingWebhookConfiguration replaceValidatingWebhookConfiguration(body) - -replace the specified ValidatingWebhookConfiguration - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1Api(configuration); - -const request: AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest = { - // name of the ValidatingWebhookConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - webhooks: [ - { - admissionReviewVersions: [ - "admissionReviewVersions_example", - ], - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchPolicy: "matchPolicy_example", - name: "name_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - sideEffects: "sideEffects_example", - timeoutSeconds: 1, - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceValidatingWebhookConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ValidatingWebhookConfiguration**| | - **name** | [**string**] | name of the ValidatingWebhookConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ValidatingWebhookConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1alpha1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1alpha1Api.md deleted file mode 100644 index 353f1bf6d99..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1alpha1Api.md +++ /dev/null @@ -1,1750 +0,0 @@ ---- -id: AdmissionregistrationV1alpha1Api -title: AdmissionregistrationV1alpha1Api -sidebar_label: AdmissionregistrationV1alpha1Api -sidebar_position: 2 ---- -# AdmissionregistrationV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**createMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**deleteCollectionMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**deleteCollectionMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**deleteMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**deleteMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/ | -[**listMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies | -[**listMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings | -[**patchMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**patchMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**readMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**readMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | -[**replaceMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicies/{name} | -[**replaceMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1alpha1Api#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1alpha1/mutatingadmissionpolicybindings/{name} | - -### createMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) - -create a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) - -create a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiCreateMutatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingAdmissionPolicy - - - -> V1Status deleteCollectionMutatingAdmissionPolicy() - -delete collection of MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingAdmissionPolicyBinding - - - -> V1Status deleteCollectionMutatingAdmissionPolicyBinding() - -delete collection of MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteMutatingAdmissionPolicy - - - -> V1Status deleteMutatingAdmissionPolicy() - -delete a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteMutatingAdmissionPolicyBinding - - - -> V1Status deleteMutatingAdmissionPolicyBinding() - -delete a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiDeleteMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() - -list or watch objects of kind MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() - -list or watch objects of kind MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiListMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) - -partially update the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) - -partially update the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiPatchMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicy readMutatingAdmissionPolicy() - -read the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() - -read the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReadMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceMutatingAdmissionPolicy - - - -> V1alpha1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) - -replace the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicy**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceMutatingAdmissionPolicyBinding - - - -> V1alpha1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) - -replace the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1alpha1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1alpha1Api(configuration); - -const request: AdmissionregistrationV1alpha1ApiReplaceMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1MutatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1beta1Api.md deleted file mode 100644 index e27b1f8e351..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/AdmissionregistrationV1beta1Api.md +++ /dev/null @@ -1,1750 +0,0 @@ ---- -id: AdmissionregistrationV1beta1Api -title: AdmissionregistrationV1beta1Api -sidebar_label: AdmissionregistrationV1beta1Api -sidebar_position: 4 ---- -# AdmissionregistrationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#createMutatingAdmissionPolicy) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**createMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#createMutatingAdmissionPolicyBinding) | **POST** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**deleteCollectionMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteCollectionMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**deleteCollectionMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteCollectionMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**deleteMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteMutatingAdmissionPolicy) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**deleteMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#deleteMutatingAdmissionPolicyBinding) | **DELETE** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**getAPIResources**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#getAPIResources) | **GET** /apis/admissionregistration.k8s.io/v1beta1/ | -[**listMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#listMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies | -[**listMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#listMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings | -[**patchMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#patchMutatingAdmissionPolicy) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**patchMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#patchMutatingAdmissionPolicyBinding) | **PATCH** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**readMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#readMutatingAdmissionPolicy) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**readMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#readMutatingAdmissionPolicyBinding) | **GET** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | -[**replaceMutatingAdmissionPolicy**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#replaceMutatingAdmissionPolicy) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name} | -[**replaceMutatingAdmissionPolicyBinding**](/docs/api-reference/cluster/AdmissionregistrationV1beta1Api#replaceMutatingAdmissionPolicyBinding) | **PUT** /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name} | - -### createMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body) - -create a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicy**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body) - -create a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicyBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingAdmissionPolicy - - - -> V1Status deleteCollectionMutatingAdmissionPolicy() - -delete collection of MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionMutatingAdmissionPolicyBinding - - - -> V1Status deleteCollectionMutatingAdmissionPolicyBinding() - -delete collection of MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteMutatingAdmissionPolicy - - - -> V1Status deleteMutatingAdmissionPolicy() - -delete a MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteMutatingAdmissionPolicyBinding - - - -> V1Status deleteMutatingAdmissionPolicyBinding() - -delete a MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicyList listMutatingAdmissionPolicy() - -list or watch objects of kind MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding() - -list or watch objects of kind MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body) - -partially update the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body) - -partially update the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicy readMutatingAdmissionPolicy() - -read the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding() - -read the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceMutatingAdmissionPolicy - - - -> V1beta1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body) - -replace the specified MutatingAdmissionPolicy - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest = { - // name of the MutatingAdmissionPolicy - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - failurePolicy: "failurePolicy_example", - matchConditions: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - matchConstraints: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - mutations: [ - { - applyConfiguration: { - expression: "expression_example", - }, - jsonPatch: { - expression: "expression_example", - }, - patchType: "patchType_example", - }, - ], - paramKind: { - apiVersion: "apiVersion_example", - kind: "kind_example", - }, - reinvocationPolicy: "reinvocationPolicy_example", - variables: [ - { - expression: "expression_example", - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicy**| | - **name** | [**string**] | name of the MutatingAdmissionPolicy | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceMutatingAdmissionPolicyBinding - - - -> V1beta1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body) - -replace the specified MutatingAdmissionPolicyBinding - -### Example - - -```typescript -import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node'; -import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AdmissionregistrationV1beta1Api(configuration); - -const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest = { - // name of the MutatingAdmissionPolicyBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - matchResources: { - excludeResourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - matchPolicy: "matchPolicy_example", - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - objectSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - apiVersions: [ - "apiVersions_example", - ], - operations: [ - "operations_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - scope: "scope_example", - }, - ], - }, - paramRef: { - name: "name_example", - namespace: "namespace_example", - parameterNotFoundAction: "parameterNotFoundAction_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - policyName: "policyName_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1MutatingAdmissionPolicyBinding**| | - **name** | [**string**] | name of the MutatingAdmissionPolicyBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1MutatingAdmissionPolicyBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsApi.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsApi.md deleted file mode 100644 index ea5d8022ad9..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: ApiextensionsApi -title: ApiextensionsApi -sidebar_label: ApiextensionsApi -sidebar_position: 5 ---- -# ApiextensionsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/cluster/ApiextensionsApi#getAPIGroup) | **GET** /apis/apiextensions.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ApiextensionsApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsV1Api.md deleted file mode 100644 index bd87829b480..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiextensionsV1Api.md +++ /dev/null @@ -1,1484 +0,0 @@ ---- -id: ApiextensionsV1Api -title: ApiextensionsV1Api -sidebar_label: ApiextensionsV1Api -sidebar_position: 6 ---- -# ApiextensionsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#createCustomResourceDefinition) | **POST** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**deleteCollectionCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#deleteCollectionCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**deleteCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#deleteCustomResourceDefinition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**getAPIResources**](/docs/api-reference/cluster/ApiextensionsV1Api#getAPIResources) | **GET** /apis/apiextensions.k8s.io/v1/ | -[**listCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#listCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions | -[**patchCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#patchCustomResourceDefinition) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**patchCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#patchCustomResourceDefinitionStatus) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | -[**readCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#readCustomResourceDefinition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**readCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#readCustomResourceDefinitionStatus) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | -[**replaceCustomResourceDefinition**](/docs/api-reference/cluster/ApiextensionsV1Api#replaceCustomResourceDefinition) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} | -[**replaceCustomResourceDefinitionStatus**](/docs/api-reference/cluster/ApiextensionsV1Api#replaceCustomResourceDefinitionStatus) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status | - -### createCustomResourceDefinition - - - -> V1CustomResourceDefinition createCustomResourceDefinition(body) - -create a CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiCreateCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiCreateCustomResourceDefinitionRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionCustomResourceDefinition - - - -> V1Status deleteCollectionCustomResourceDefinition() - -delete collection of CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiDeleteCollectionCustomResourceDefinitionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCustomResourceDefinition - - - -> V1Status deleteCustomResourceDefinition() - -delete a CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiDeleteCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCustomResourceDefinition - - - -> V1CustomResourceDefinitionList listCustomResourceDefinition() - -list or watch objects of kind CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiListCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiListCustomResourceDefinitionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinitionList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchCustomResourceDefinition - - - -> V1CustomResourceDefinition patchCustomResourceDefinition(body) - -partially update the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiPatchCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiPatchCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchCustomResourceDefinitionStatus - - - -> V1CustomResourceDefinition patchCustomResourceDefinitionStatus(body) - -partially update status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiPatchCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readCustomResourceDefinition - - - -> V1CustomResourceDefinition readCustomResourceDefinition() - -read the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiReadCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReadCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readCustomResourceDefinitionStatus - - - -> V1CustomResourceDefinition readCustomResourceDefinitionStatus() - -read status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReadCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceCustomResourceDefinition - - - -> V1CustomResourceDefinition replaceCustomResourceDefinition(body) - -replace the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCustomResourceDefinition(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceCustomResourceDefinitionStatus - - - -> V1CustomResourceDefinition replaceCustomResourceDefinitionStatus(body) - -replace status of the specified CustomResourceDefinition - -### Example - - -```typescript -import { createConfiguration, ApiextensionsV1Api } from '@kubernetes/client-node'; -import type { ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiextensionsV1Api(configuration); - -const request: ApiextensionsV1ApiReplaceCustomResourceDefinitionStatusRequest = { - // name of the CustomResourceDefinition - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - conversion: { - strategy: "strategy_example", - webhook: { - clientConfig: { - caBundle: 'YQ==', - service: { - name: "name_example", - namespace: "namespace_example", - path: "path_example", - port: 1, - }, - url: "url_example", - }, - conversionReviewVersions: [ - "conversionReviewVersions_example", - ], - }, - }, - group: "group_example", - names: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - preserveUnknownFields: true, - scope: "scope_example", - versions: [ - { - additionalPrinterColumns: [ - { - description: "description_example", - format: "format_example", - jsonPath: "jsonPath_example", - name: "name_example", - priority: 1, - type: "type_example", - }, - ], - deprecated: true, - deprecationWarning: "deprecationWarning_example", - name: "name_example", - schema: { - openAPIV3Schema: { - ref: "ref_example", - schema: "schema_example", - additionalItems: {}, - additionalProperties: {}, - allOf: [ - , - ], - anyOf: [ - , - ], - _default: {}, - definitions: { - "key": , - }, - dependencies: { - "key": {}, - }, - description: "description_example", - _enum: [ - {}, - ], - example: {}, - exclusiveMaximum: true, - exclusiveMinimum: true, - externalDocs: { - description: "description_example", - url: "url_example", - }, - format: "format_example", - id: "id_example", - items: {}, - maxItems: 1, - maxLength: 1, - maxProperties: 1, - maximum: 3.14, - minItems: 1, - minLength: 1, - minProperties: 1, - minimum: 3.14, - multipleOf: 3.14, - not: , - nullable: true, - oneOf: [ - , - ], - pattern: "pattern_example", - patternProperties: { - "key": , - }, - properties: { - "key": , - }, - required: [ - "required_example", - ], - title: "title_example", - type: "type_example", - uniqueItems: true, - x_kubernetes_embedded_resource: true, - x_kubernetes_int_or_string: true, - x_kubernetes_list_map_keys: [ - "x_kubernetes_list_map_keys_example", - ], - x_kubernetes_list_type: "x_kubernetes_list_type_example", - x_kubernetes_map_type: "x_kubernetes_map_type_example", - x_kubernetes_preserve_unknown_fields: true, - x_kubernetes_validations: [ - { - fieldPath: "fieldPath_example", - message: "message_example", - messageExpression: "messageExpression_example", - optionalOldSelf: true, - reason: "reason_example", - rule: "rule_example", - }, - ], - }, - }, - selectableFields: [ - { - jsonPath: "jsonPath_example", - }, - ], - served: true, - storage: true, - subresources: { - scale: { - labelSelectorPath: "labelSelectorPath_example", - specReplicasPath: "specReplicasPath_example", - statusReplicasPath: "statusReplicasPath_example", - }, - status: {}, - }, - }, - ], - }, - status: { - acceptedNames: { - categories: [ - "categories_example", - ], - kind: "kind_example", - listKind: "listKind_example", - plural: "plural_example", - shortNames: [ - "shortNames_example", - ], - singular: "singular_example", - }, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - storedVersions: [ - "storedVersions_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCustomResourceDefinitionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CustomResourceDefinition**| | - **name** | [**string**] | name of the CustomResourceDefinition | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CustomResourceDefinition - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationApi.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationApi.md deleted file mode 100644 index d129ebb0855..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: ApiregistrationApi -title: ApiregistrationApi -sidebar_label: ApiregistrationApi -sidebar_position: 7 ---- -# ApiregistrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/cluster/ApiregistrationApi#getAPIGroup) | **GET** /apis/apiregistration.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ApiregistrationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationV1Api.md deleted file mode 100644 index 962919a679a..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/ApiregistrationV1Api.md +++ /dev/null @@ -1,1031 +0,0 @@ ---- -id: ApiregistrationV1Api -title: ApiregistrationV1Api -sidebar_label: ApiregistrationV1Api -sidebar_position: 8 ---- -# ApiregistrationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#createAPIService) | **POST** /apis/apiregistration.k8s.io/v1/apiservices | -[**deleteAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#deleteAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**deleteCollectionAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#deleteCollectionAPIService) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices | -[**getAPIResources**](/docs/api-reference/cluster/ApiregistrationV1Api#getAPIResources) | **GET** /apis/apiregistration.k8s.io/v1/ | -[**listAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#listAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices | -[**patchAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#patchAPIService) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**patchAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#patchAPIServiceStatus) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | -[**readAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#readAPIService) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**readAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#readAPIServiceStatus) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | -[**replaceAPIService**](/docs/api-reference/cluster/ApiregistrationV1Api#replaceAPIService) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name} | -[**replaceAPIServiceStatus**](/docs/api-reference/cluster/ApiregistrationV1Api#replaceAPIServiceStatus) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status | - -### createAPIService - - - -> V1APIService createAPIService(body) - -create an APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiCreateAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiCreateAPIServiceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteAPIService - - - -> V1Status deleteAPIService() - -delete an APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiDeleteAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiDeleteAPIServiceRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionAPIService - - - -> V1Status deleteCollectionAPIService() - -delete collection of APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiDeleteCollectionAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiDeleteCollectionAPIServiceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listAPIService - - - -> V1APIServiceList listAPIService() - -list or watch objects of kind APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiListAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiListAPIServiceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1APIServiceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchAPIService - - - -> V1APIService patchAPIService(body) - -partially update the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiPatchAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiPatchAPIServiceRequest = { - // name of the APIService - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchAPIServiceStatus - - - -> V1APIService patchAPIServiceStatus(body) - -partially update status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiPatchAPIServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiPatchAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readAPIService - - - -> V1APIService readAPIService() - -read the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiReadAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReadAPIServiceRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readAPIServiceStatus - - - -> V1APIService readAPIServiceStatus() - -read status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiReadAPIServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReadAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceAPIService - - - -> V1APIService replaceAPIService(body) - -replace the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiReplaceAPIServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReplaceAPIServiceRequest = { - // name of the APIService - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceAPIService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceAPIServiceStatus - - - -> V1APIService replaceAPIServiceStatus(body) - -replace status of the specified APIService - -### Example - - -```typescript -import { createConfiguration, ApiregistrationV1Api } from '@kubernetes/client-node'; -import type { ApiregistrationV1ApiReplaceAPIServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApiregistrationV1Api(configuration); - -const request: ApiregistrationV1ApiReplaceAPIServiceStatusRequest = { - // name of the APIService - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - caBundle: 'YQ==', - group: "group_example", - groupPriorityMinimum: 1, - insecureSkipTLSVerify: true, - service: { - name: "name_example", - namespace: "namespace_example", - port: 1, - }, - version: "version_example", - versionPriority: 1, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceAPIServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1APIService**| | - **name** | [**string**] | name of the APIService | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1APIService - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingApi.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingApi.md deleted file mode 100644 index 574a8c7d9b8..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: SchedulingApi -title: SchedulingApi -sidebar_label: SchedulingApi -sidebar_position: 9 ---- -# SchedulingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/cluster/SchedulingApi#getAPIGroup) | **GET** /apis/scheduling.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, SchedulingApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1Api.md deleted file mode 100644 index 2bb8614b6f4..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1Api.md +++ /dev/null @@ -1,719 +0,0 @@ ---- -id: SchedulingV1Api -title: SchedulingV1Api -sidebar_label: SchedulingV1Api -sidebar_position: 11 ---- -# SchedulingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#createPriorityClass) | **POST** /apis/scheduling.k8s.io/v1/priorityclasses | -[**deleteCollectionPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#deleteCollectionPriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses | -[**deletePriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#deletePriorityClass) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**getAPIResources**](/docs/api-reference/cluster/SchedulingV1Api#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1/ | -[**listPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#listPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses | -[**patchPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#patchPriorityClass) | **PATCH** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**readPriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#readPriorityClass) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | -[**replacePriorityClass**](/docs/api-reference/cluster/SchedulingV1Api#replacePriorityClass) | **PUT** /apis/scheduling.k8s.io/v1/priorityclasses/{name} | - -### createPriorityClass - - - -> V1PriorityClass createPriorityClass(body) - -create a PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiCreatePriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiCreatePriorityClassRequest = { - - body: { - apiVersion: "apiVersion_example", - description: "description_example", - globalDefault: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - preemptionPolicy: "preemptionPolicy_example", - value: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionPriorityClass - - - -> V1Status deleteCollectionPriorityClass() - -delete collection of PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiDeleteCollectionPriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiDeleteCollectionPriorityClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deletePriorityClass - - - -> V1Status deletePriorityClass() - -delete a PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiDeletePriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiDeletePriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPriorityClass - - - -> V1PriorityClassList listPriorityClass() - -list or watch objects of kind PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiListPriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiListPriorityClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PriorityClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchPriorityClass - - - -> V1PriorityClass patchPriorityClass(body) - -partially update the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiPatchPriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiPatchPriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PriorityClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readPriorityClass - - - -> V1PriorityClass readPriorityClass() - -read the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiReadPriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiReadPriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PriorityClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replacePriorityClass - - - -> V1PriorityClass replacePriorityClass(body) - -replace the specified PriorityClass - -### Example - - -```typescript -import { createConfiguration, SchedulingV1Api } from '@kubernetes/client-node'; -import type { SchedulingV1ApiReplacePriorityClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1Api(configuration); - -const request: SchedulingV1ApiReplacePriorityClassRequest = { - // name of the PriorityClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - description: "description_example", - globalDefault: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - preemptionPolicy: "preemptionPolicy_example", - value: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityClass**| | - **name** | [**string**] | name of the PriorityClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1alpha1Api.md b/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1alpha1Api.md deleted file mode 100644 index 73e5bfc18f5..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/SchedulingV1alpha1Api.md +++ /dev/null @@ -1,853 +0,0 @@ ---- -id: SchedulingV1alpha1Api -title: SchedulingV1alpha1Api -sidebar_label: SchedulingV1alpha1Api -sidebar_position: 10 ---- -# SchedulingV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#createNamespacedWorkload) | **POST** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**deleteCollectionNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#deleteCollectionNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**deleteNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#deleteNamespacedWorkload) | **DELETE** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**getAPIResources**](/docs/api-reference/cluster/SchedulingV1alpha1Api#getAPIResources) | **GET** /apis/scheduling.k8s.io/v1alpha1/ | -[**listNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#listNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads | -[**listWorkloadForAllNamespaces**](/docs/api-reference/cluster/SchedulingV1alpha1Api#listWorkloadForAllNamespaces) | **GET** /apis/scheduling.k8s.io/v1alpha1/workloads | -[**patchNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#patchNamespacedWorkload) | **PATCH** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**readNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#readNamespacedWorkload) | **GET** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | -[**replaceNamespacedWorkload**](/docs/api-reference/cluster/SchedulingV1alpha1Api#replaceNamespacedWorkload) | **PUT** /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name} | - -### createNamespacedWorkload - - - -> V1alpha1Workload createNamespacedWorkload(body) - -create a Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiCreateNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controllerRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - podGroups: [ - { - name: "name_example", - policy: { - basic: {}, - gang: { - minCount: 1, - }, - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1Workload**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1Workload - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedWorkload - - - -> V1Status deleteCollectionNamespacedWorkload() - -delete collection of Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiDeleteCollectionNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedWorkload - - - -> V1Status deleteNamespacedWorkload() - -delete a Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiDeleteNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedWorkload - - - -> V1alpha1WorkloadList listNamespacedWorkload() - -list or watch objects of kind Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiListNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiListNamespacedWorkloadRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1WorkloadList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listWorkloadForAllNamespaces - - - -> V1alpha1WorkloadList listWorkloadForAllNamespaces() - -list or watch objects of kind Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiListWorkloadForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listWorkloadForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1WorkloadList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedWorkload - - - -> V1alpha1Workload patchNamespacedWorkload(body) - -partially update the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiPatchNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1Workload - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedWorkload - - - -> V1alpha1Workload readNamespacedWorkload() - -read the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiReadNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiReadNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1Workload - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedWorkload - - - -> V1alpha1Workload replaceNamespacedWorkload(body) - -replace the specified Workload - -### Example - - -```typescript -import { createConfiguration, SchedulingV1alpha1Api } from '@kubernetes/client-node'; -import type { SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new SchedulingV1alpha1Api(configuration); - -const request: SchedulingV1alpha1ApiReplaceNamespacedWorkloadRequest = { - // name of the Workload - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controllerRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - podGroups: [ - { - name: "name_example", - policy: { - basic: {}, - gang: { - minCount: 1, - }, - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedWorkload(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1Workload**| | - **name** | [**string**] | name of the Workload | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1Workload - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/cluster/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/cluster/_category_.json deleted file mode 100644 index 0cc46b9cf1e..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/cluster/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Cluster", - "position": 6 -} diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationApi.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationApi.md deleted file mode 100644 index 80b8df4938e..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: CoordinationApi -title: CoordinationApi -sidebar_label: CoordinationApi -sidebar_position: 1 ---- -# CoordinationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/configuration-storage/CoordinationApi#getAPIGroup) | **GET** /apis/coordination.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, CoordinationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1Api.md deleted file mode 100644 index 9473e68ac7a..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1Api.md +++ /dev/null @@ -1,835 +0,0 @@ ---- -id: CoordinationV1Api -title: CoordinationV1Api -sidebar_label: CoordinationV1Api -sidebar_position: 3 ---- -# CoordinationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#createNamespacedLease) | **POST** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**deleteCollectionNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#deleteCollectionNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**deleteNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#deleteNamespacedLease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1/ | -[**listLeaseForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1Api#listLeaseForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1/leases | -[**listNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#listNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases | -[**patchNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#patchNamespacedLease) | **PATCH** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**readNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#readNamespacedLease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | -[**replaceNamespacedLease**](/docs/api-reference/configuration-storage/CoordinationV1Api#replaceNamespacedLease) | **PUT** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} | - -### createNamespacedLease - - - -> V1Lease createNamespacedLease(body) - -create a Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiCreateNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiCreateNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - acquireTime: "acquireTime_example", - holderIdentity: "holderIdentity_example", - leaseDurationSeconds: 1, - leaseTransitions: 1, - preferredHolder: "preferredHolder_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Lease**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Lease - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedLease - - - -> V1Status deleteCollectionNamespacedLease() - -delete collection of Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiDeleteCollectionNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedLease - - - -> V1Status deleteNamespacedLease() - -delete a Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiDeleteNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiDeleteNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listLeaseForAllNamespaces - - - -> V1LeaseList listLeaseForAllNamespaces() - -list or watch objects of kind Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiListLeaseForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiListLeaseForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1LeaseList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedLease - - - -> V1LeaseList listNamespacedLease() - -list or watch objects of kind Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiListNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiListNamespacedLeaseRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1LeaseList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedLease - - - -> V1Lease patchNamespacedLease(body) - -partially update the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiPatchNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiPatchNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Lease - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedLease - - - -> V1Lease readNamespacedLease() - -read the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiReadNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiReadNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Lease - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedLease - - - -> V1Lease replaceNamespacedLease(body) - -replace the specified Lease - -### Example - - -```typescript -import { createConfiguration, CoordinationV1Api } from '@kubernetes/client-node'; -import type { CoordinationV1ApiReplaceNamespacedLeaseRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1Api(configuration); - -const request: CoordinationV1ApiReplaceNamespacedLeaseRequest = { - // name of the Lease - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - acquireTime: "acquireTime_example", - holderIdentity: "holderIdentity_example", - leaseDurationSeconds: 1, - leaseTransitions: 1, - preferredHolder: "preferredHolder_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLease(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Lease**| | - **name** | [**string**] | name of the Lease | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Lease - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1alpha2Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1alpha2Api.md deleted file mode 100644 index 28670d08afe..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1alpha2Api.md +++ /dev/null @@ -1,833 +0,0 @@ ---- -id: CoordinationV1alpha2Api -title: CoordinationV1alpha2Api -sidebar_label: CoordinationV1alpha2Api -sidebar_position: 2 ---- -# CoordinationV1alpha2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**deleteCollectionNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**deleteNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1alpha2/ | -[**listLeaseCandidateForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1alpha2/leasecandidates | -[**listNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates | -[**patchNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**readNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | -[**replaceNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1alpha2Api#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} | - -### createNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidate createNamespacedLeaseCandidate(body) - -create a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiCreateNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2LeaseCandidate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedLeaseCandidate - - - -> V1Status deleteCollectionNamespacedLeaseCandidate() - -delete collection of LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiDeleteCollectionNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedLeaseCandidate - - - -> V1Status deleteNamespacedLeaseCandidate() - -delete a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiDeleteNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listLeaseCandidateForAllNamespaces - - - -> V1alpha2LeaseCandidateList listLeaseCandidateForAllNamespaces() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiListLeaseCandidateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidateList listNamespacedLeaseCandidate() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiListNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidate patchNamespacedLeaseCandidate(body) - -partially update the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiPatchNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidate readNamespacedLeaseCandidate() - -read the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiReadNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedLeaseCandidate - - - -> V1alpha2LeaseCandidate replaceNamespacedLeaseCandidate(body) - -replace the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1alpha2Api } from '@kubernetes/client-node'; -import type { CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1alpha2Api(configuration); - -const request: CoordinationV1alpha2ApiReplaceNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha2LeaseCandidate**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha2LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1beta1Api.md deleted file mode 100644 index ae939c61b48..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/CoordinationV1beta1Api.md +++ /dev/null @@ -1,833 +0,0 @@ ---- -id: CoordinationV1beta1Api -title: CoordinationV1beta1Api -sidebar_label: CoordinationV1beta1Api -sidebar_position: 4 ---- -# CoordinationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#createNamespacedLeaseCandidate) | **POST** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**deleteCollectionNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#deleteCollectionNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**deleteNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#deleteNamespacedLeaseCandidate) | **DELETE** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#getAPIResources) | **GET** /apis/coordination.k8s.io/v1beta1/ | -[**listLeaseCandidateForAllNamespaces**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#listLeaseCandidateForAllNamespaces) | **GET** /apis/coordination.k8s.io/v1beta1/leasecandidates | -[**listNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#listNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates | -[**patchNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#patchNamespacedLeaseCandidate) | **PATCH** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**readNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#readNamespacedLeaseCandidate) | **GET** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | -[**replaceNamespacedLeaseCandidate**](/docs/api-reference/configuration-storage/CoordinationV1beta1Api#replaceNamespacedLeaseCandidate) | **PUT** /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name} | - -### createNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidate createNamespacedLeaseCandidate(body) - -create a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiCreateNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1LeaseCandidate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedLeaseCandidate - - - -> V1Status deleteCollectionNamespacedLeaseCandidate() - -delete collection of LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiDeleteCollectionNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedLeaseCandidate - - - -> V1Status deleteNamespacedLeaseCandidate() - -delete a LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiDeleteNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listLeaseCandidateForAllNamespaces - - - -> V1beta1LeaseCandidateList listLeaseCandidateForAllNamespaces() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiListLeaseCandidateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLeaseCandidateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidateList listNamespacedLeaseCandidate() - -list or watch objects of kind LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiListNamespacedLeaseCandidateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidate patchNamespacedLeaseCandidate(body) - -partially update the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiPatchNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidate readNamespacedLeaseCandidate() - -read the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiReadNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedLeaseCandidate - - - -> V1beta1LeaseCandidate replaceNamespacedLeaseCandidate(body) - -replace the specified LeaseCandidate - -### Example - - -```typescript -import { createConfiguration, CoordinationV1beta1Api } from '@kubernetes/client-node'; -import type { CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoordinationV1beta1Api(configuration); - -const request: CoordinationV1beta1ApiReplaceNamespacedLeaseCandidateRequest = { - // name of the LeaseCandidate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - binaryVersion: "binaryVersion_example", - emulationVersion: "emulationVersion_example", - leaseName: "leaseName_example", - pingTime: "pingTime_example", - renewTime: "renewTime_example", - strategy: "strategy_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLeaseCandidate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1LeaseCandidate**| | - **name** | [**string**] | name of the LeaseCandidate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1LeaseCandidate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyApi.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyApi.md deleted file mode 100644 index 3dc65d31ce0..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: PolicyApi -title: PolicyApi -sidebar_label: PolicyApi -sidebar_position: 5 ---- -# PolicyApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/configuration-storage/PolicyApi#getAPIGroup) | **GET** /apis/policy/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, PolicyApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyV1Api.md deleted file mode 100644 index 57e052b9fb7..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/PolicyV1Api.md +++ /dev/null @@ -1,1191 +0,0 @@ ---- -id: PolicyV1Api -title: PolicyV1Api -sidebar_label: PolicyV1Api -sidebar_position: 6 ---- -# PolicyV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#createNamespacedPodDisruptionBudget) | **POST** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**deleteCollectionNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#deleteCollectionNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**deleteNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#deleteNamespacedPodDisruptionBudget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/PolicyV1Api#getAPIResources) | **GET** /apis/policy/v1/ | -[**listNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#listNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets | -[**listPodDisruptionBudgetForAllNamespaces**](/docs/api-reference/configuration-storage/PolicyV1Api#listPodDisruptionBudgetForAllNamespaces) | **GET** /apis/policy/v1/poddisruptionbudgets | -[**patchNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#patchNamespacedPodDisruptionBudget) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**patchNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#patchNamespacedPodDisruptionBudgetStatus) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | -[**readNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#readNamespacedPodDisruptionBudget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**readNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#readNamespacedPodDisruptionBudgetStatus) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | -[**replaceNamespacedPodDisruptionBudget**](/docs/api-reference/configuration-storage/PolicyV1Api#replaceNamespacedPodDisruptionBudget) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} | -[**replaceNamespacedPodDisruptionBudgetStatus**](/docs/api-reference/configuration-storage/PolicyV1Api#replaceNamespacedPodDisruptionBudgetStatus) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status | - -### createNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudget createNamespacedPodDisruptionBudget(body) - -create a PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiCreateNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPodDisruptionBudget - - - -> V1Status deleteCollectionNamespacedPodDisruptionBudget() - -delete collection of PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiDeleteCollectionNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedPodDisruptionBudget - - - -> V1Status deleteNamespacedPodDisruptionBudget() - -delete a PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiDeleteNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudgetList listNamespacedPodDisruptionBudget() - -list or watch objects of kind PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiListNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiListNamespacedPodDisruptionBudgetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudgetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPodDisruptionBudgetForAllNamespaces - - - -> V1PodDisruptionBudgetList listPodDisruptionBudgetForAllNamespaces() - -list or watch objects of kind PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiListPodDisruptionBudgetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodDisruptionBudgetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudgetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudget patchNamespacedPodDisruptionBudget(body) - -partially update the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodDisruptionBudgetStatus - - - -> V1PodDisruptionBudget patchNamespacedPodDisruptionBudgetStatus(body) - -partially update status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiPatchNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudget readNamespacedPodDisruptionBudget() - -read the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodDisruptionBudgetStatus - - - -> V1PodDisruptionBudget readNamespacedPodDisruptionBudgetStatus() - -read status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReadNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodDisruptionBudget - - - -> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudget(body) - -replace the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodDisruptionBudget(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodDisruptionBudgetStatus - - - -> V1PodDisruptionBudget replaceNamespacedPodDisruptionBudgetStatus(body) - -replace status of the specified PodDisruptionBudget - -### Example - - -```typescript -import { createConfiguration, PolicyV1Api } from '@kubernetes/client-node'; -import type { PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new PolicyV1Api(configuration); - -const request: PolicyV1ApiReplaceNamespacedPodDisruptionBudgetStatusRequest = { - // name of the PodDisruptionBudget - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxUnavailable: "maxUnavailable_example", - minAvailable: "minAvailable_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - unhealthyPodEvictionPolicy: "unhealthyPodEvictionPolicy_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentHealthy: 1, - desiredHealthy: 1, - disruptedPods: { - "key": new Date('1970-01-01T00:00:00.00Z'), - }, - disruptionsAllowed: 1, - expectedPods: 1, - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodDisruptionBudgetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodDisruptionBudget**| | - **name** | [**string**] | name of the PodDisruptionBudget | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodDisruptionBudget - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageApi.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageApi.md deleted file mode 100644 index e5460e8bc7e..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: StorageApi -title: StorageApi -sidebar_label: StorageApi -sidebar_position: 7 ---- -# StorageApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/configuration-storage/StorageApi#getAPIGroup) | **GET** /apis/storage.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, StorageApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1Api.md deleted file mode 100644 index 5a7b8715d3c..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1Api.md +++ /dev/null @@ -1,5308 +0,0 @@ ---- -id: StorageV1Api -title: StorageV1Api -sidebar_label: StorageV1Api -sidebar_position: 10 ---- -# StorageV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#createCSIDriver) | **POST** /apis/storage.k8s.io/v1/csidrivers | -[**createCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#createCSINode) | **POST** /apis/storage.k8s.io/v1/csinodes | -[**createNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#createNamespacedCSIStorageCapacity) | **POST** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**createStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#createStorageClass) | **POST** /apis/storage.k8s.io/v1/storageclasses | -[**createVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#createVolumeAttachment) | **POST** /apis/storage.k8s.io/v1/volumeattachments | -[**createVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**deleteCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**deleteCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes/{name} | -[**deleteCollectionCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionCSIDriver) | **DELETE** /apis/storage.k8s.io/v1/csidrivers | -[**deleteCollectionCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionCSINode) | **DELETE** /apis/storage.k8s.io/v1/csinodes | -[**deleteCollectionNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**deleteCollectionStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses | -[**deleteCollectionVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments | -[**deleteCollectionVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**deleteNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#deleteNamespacedCSIStorageCapacity) | **DELETE** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**deleteStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteStorageClass) | **DELETE** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**deleteVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#deleteVolumeAttachment) | **DELETE** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**deleteVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/StorageV1Api#getAPIResources) | **GET** /apis/storage.k8s.io/v1/ | -[**listCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#listCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers | -[**listCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#listCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes | -[**listCSIStorageCapacityForAllNamespaces**](/docs/api-reference/configuration-storage/StorageV1Api#listCSIStorageCapacityForAllNamespaces) | **GET** /apis/storage.k8s.io/v1/csistoragecapacities | -[**listNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#listNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities | -[**listStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#listStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses | -[**listVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#listVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments | -[**listVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses | -[**patchCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#patchCSIDriver) | **PATCH** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**patchCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#patchCSINode) | **PATCH** /apis/storage.k8s.io/v1/csinodes/{name} | -[**patchNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#patchNamespacedCSIStorageCapacity) | **PATCH** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**patchStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#patchStorageClass) | **PATCH** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**patchVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttachment) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**patchVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttachmentStatus) | **PATCH** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**patchVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**readCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#readCSIDriver) | **GET** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**readCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#readCSINode) | **GET** /apis/storage.k8s.io/v1/csinodes/{name} | -[**readNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#readNamespacedCSIStorageCapacity) | **GET** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**readStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#readStorageClass) | **GET** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**readVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttachment) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**readVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttachmentStatus) | **GET** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**readVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | -[**replaceCSIDriver**](/docs/api-reference/configuration-storage/StorageV1Api#replaceCSIDriver) | **PUT** /apis/storage.k8s.io/v1/csidrivers/{name} | -[**replaceCSINode**](/docs/api-reference/configuration-storage/StorageV1Api#replaceCSINode) | **PUT** /apis/storage.k8s.io/v1/csinodes/{name} | -[**replaceNamespacedCSIStorageCapacity**](/docs/api-reference/configuration-storage/StorageV1Api#replaceNamespacedCSIStorageCapacity) | **PUT** /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name} | -[**replaceStorageClass**](/docs/api-reference/configuration-storage/StorageV1Api#replaceStorageClass) | **PUT** /apis/storage.k8s.io/v1/storageclasses/{name} | -[**replaceVolumeAttachment**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttachment) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name} | -[**replaceVolumeAttachmentStatus**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttachmentStatus) | **PUT** /apis/storage.k8s.io/v1/volumeattachments/{name}/status | -[**replaceVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1Api#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1/volumeattributesclasses/{name} | - -### createCSIDriver - - - -> V1CSIDriver createCSIDriver(body) - -create a CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateCSIDriverRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attachRequired: true, - fsGroupPolicy: "fsGroupPolicy_example", - nodeAllocatableUpdatePeriodSeconds: 1, - podInfoOnMount: true, - requiresRepublish: true, - seLinuxMount: true, - serviceAccountTokenInSecrets: true, - storageCapacity: true, - tokenRequests: [ - { - audience: "audience_example", - expirationSeconds: 1, - }, - ], - volumeLifecycleModes: [ - "volumeLifecycleModes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIDriver**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createCSINode - - - -> V1CSINode createCSINode(body) - -create a CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateCSINodeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - drivers: [ - { - allocatable: { - count: 1, - }, - name: "name_example", - nodeID: "nodeID_example", - topologyKeys: [ - "topologyKeys_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSINode**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacity createNamespacedCSIStorageCapacity(body) - -create a CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - capacity: "capacity_example", - kind: "kind_example", - maximumVolumeSize: "maximumVolumeSize_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - nodeTopology: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIStorageCapacity**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacity - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createStorageClass - - - -> V1StorageClass createStorageClass(body) - -create a StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateStorageClassRequest = { - - body: { - allowVolumeExpansion: true, - allowedTopologies: [ - { - matchLabelExpressions: [ - { - key: "key_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - mountOptions: [ - "mountOptions_example", - ], - parameters: { - "key": "key_example", - }, - provisioner: "provisioner_example", - reclaimPolicy: "reclaimPolicy_example", - volumeBindingMode: "volumeBindingMode_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StorageClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createVolumeAttachment - - - -> V1VolumeAttachment createVolumeAttachment(body) - -create a VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateVolumeAttachmentRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createVolumeAttributesClass - - - -> V1VolumeAttributesClass createVolumeAttributesClass(body) - -create a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiCreateVolumeAttributesClassRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttributesClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCSIDriver - - - -> V1CSIDriver deleteCSIDriver() - -delete a CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCSINode - - - -> V1CSINode deleteCSINode() - -delete a CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCSINodeRequest = { - // name of the CSINode - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionCSIDriver - - - -> V1Status deleteCollectionCSIDriver() - -delete collection of CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionCSIDriverRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionCSINode - - - -> V1Status deleteCollectionCSINode() - -delete collection of CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionCSINodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedCSIStorageCapacity - - - -> V1Status deleteCollectionNamespacedCSIStorageCapacity() - -delete collection of CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionStorageClass - - - -> V1Status deleteCollectionStorageClass() - -delete collection of StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionStorageClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionVolumeAttachment - - - -> V1Status deleteCollectionVolumeAttachment() - -delete collection of VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionVolumeAttachmentRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionVolumeAttributesClass - - - -> V1Status deleteCollectionVolumeAttributesClass() - -delete collection of VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteCollectionVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedCSIStorageCapacity - - - -> V1Status deleteNamespacedCSIStorageCapacity() - -delete a CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteStorageClass - - - -> V1StorageClass deleteStorageClass() - -delete a StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteStorageClassRequest = { - // name of the StorageClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteVolumeAttachment - - - -> V1VolumeAttachment deleteVolumeAttachment() - -delete a VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteVolumeAttributesClass - - - -> V1VolumeAttributesClass deleteVolumeAttributesClass() - -delete a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiDeleteVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCSIDriver - - - -> V1CSIDriverList listCSIDriver() - -list or watch objects of kind CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSIDriverRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CSIDriverList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCSINode - - - -> V1CSINodeList listCSINode() - -list or watch objects of kind CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSINodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CSINodeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCSIStorageCapacityForAllNamespaces - - - -> V1CSIStorageCapacityList listCSIStorageCapacityForAllNamespaces() - -list or watch objects of kind CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCSIStorageCapacityForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacityList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacityList listNamespacedCSIStorageCapacity() - -list or watch objects of kind CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListNamespacedCSIStorageCapacityRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacityList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listStorageClass - - - -> V1StorageClassList listStorageClass() - -list or watch objects of kind StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListStorageClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1StorageClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listVolumeAttachment - - - -> V1VolumeAttachmentList listVolumeAttachment() - -list or watch objects of kind VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListVolumeAttachmentRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachmentList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listVolumeAttributesClass - - - -> V1VolumeAttributesClassList listVolumeAttributesClass() - -list or watch objects of kind VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiListVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchCSIDriver - - - -> V1CSIDriver patchCSIDriver(body) - -partially update the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchCSINode - - - -> V1CSINode patchCSINode(body) - -partially update the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchCSINodeRequest = { - // name of the CSINode - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacity patchNamespacedCSIStorageCapacity(body) - -partially update the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacity - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchStorageClass - - - -> V1StorageClass patchStorageClass(body) - -partially update the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchStorageClassRequest = { - // name of the StorageClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchVolumeAttachment - - - -> V1VolumeAttachment patchVolumeAttachment(body) - -partially update the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchVolumeAttachmentStatus - - - -> V1VolumeAttachment patchVolumeAttachmentStatus(body) - -partially update status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchVolumeAttributesClass - - - -> V1VolumeAttributesClass patchVolumeAttributesClass(body) - -partially update the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiPatchVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readCSIDriver - - - -> V1CSIDriver readCSIDriver() - -read the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readCSINode - - - -> V1CSINode readCSINode() - -read the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadCSINodeRequest = { - // name of the CSINode - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacity readNamespacedCSIStorageCapacity() - -read the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacity - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readStorageClass - - - -> V1StorageClass readStorageClass() - -read the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadStorageClassRequest = { - // name of the StorageClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readVolumeAttachment - - - -> V1VolumeAttachment readVolumeAttachment() - -read the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readVolumeAttachmentStatus - - - -> V1VolumeAttachment readVolumeAttachmentStatus() - -read status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readVolumeAttributesClass - - - -> V1VolumeAttributesClass readVolumeAttributesClass() - -read the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReadVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceCSIDriver - - - -> V1CSIDriver replaceCSIDriver(body) - -replace the specified CSIDriver - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceCSIDriverRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceCSIDriverRequest = { - // name of the CSIDriver - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attachRequired: true, - fsGroupPolicy: "fsGroupPolicy_example", - nodeAllocatableUpdatePeriodSeconds: 1, - podInfoOnMount: true, - requiresRepublish: true, - seLinuxMount: true, - serviceAccountTokenInSecrets: true, - storageCapacity: true, - tokenRequests: [ - { - audience: "audience_example", - expirationSeconds: 1, - }, - ], - volumeLifecycleModes: [ - "volumeLifecycleModes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCSIDriver(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIDriver**| | - **name** | [**string**] | name of the CSIDriver | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSIDriver - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceCSINode - - - -> V1CSINode replaceCSINode(body) - -replace the specified CSINode - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceCSINodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceCSINodeRequest = { - // name of the CSINode - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - drivers: [ - { - allocatable: { - count: 1, - }, - name: "name_example", - nodeID: "nodeID_example", - topologyKeys: [ - "topologyKeys_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCSINode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSINode**| | - **name** | [**string**] | name of the CSINode | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSINode - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedCSIStorageCapacity - - - -> V1CSIStorageCapacity replaceNamespacedCSIStorageCapacity(body) - -replace the specified CSIStorageCapacity - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest = { - // name of the CSIStorageCapacity - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - capacity: "capacity_example", - kind: "kind_example", - maximumVolumeSize: "maximumVolumeSize_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - nodeTopology: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCSIStorageCapacity(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CSIStorageCapacity**| | - **name** | [**string**] | name of the CSIStorageCapacity | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CSIStorageCapacity - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceStorageClass - - - -> V1StorageClass replaceStorageClass(body) - -replace the specified StorageClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceStorageClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceStorageClassRequest = { - // name of the StorageClass - name: "name_example", - - body: { - allowVolumeExpansion: true, - allowedTopologies: [ - { - matchLabelExpressions: [ - { - key: "key_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - mountOptions: [ - "mountOptions_example", - ], - parameters: { - "key": "key_example", - }, - provisioner: "provisioner_example", - reclaimPolicy: "reclaimPolicy_example", - volumeBindingMode: "volumeBindingMode_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StorageClass**| | - **name** | [**string**] | name of the StorageClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StorageClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceVolumeAttachment - - - -> V1VolumeAttachment replaceVolumeAttachment(body) - -replace the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceVolumeAttachmentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttachmentRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttachment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceVolumeAttachmentStatus - - - -> V1VolumeAttachment replaceVolumeAttachmentStatus(body) - -replace status of the specified VolumeAttachment - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceVolumeAttachmentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttachmentStatusRequest = { - // name of the VolumeAttachment - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - attacher: "attacher_example", - nodeName: "nodeName_example", - source: { - inlineVolumeSpec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - persistentVolumeName: "persistentVolumeName_example", - }, - }, - status: { - attachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - attached: true, - attachmentMetadata: { - "key": "key_example", - }, - detachError: { - errorCode: 1, - message: "message_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttachmentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttachment**| | - **name** | [**string**] | name of the VolumeAttachment | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttachment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceVolumeAttributesClass - - - -> V1VolumeAttributesClass replaceVolumeAttributesClass(body) - -replace the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1Api } from '@kubernetes/client-node'; -import type { StorageV1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1Api(configuration); - -const request: StorageV1ApiReplaceVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1VolumeAttributesClass**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1beta1Api.md deleted file mode 100644 index f868ee6bae8..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StorageV1beta1Api.md +++ /dev/null @@ -1,719 +0,0 @@ ---- -id: StorageV1beta1Api -title: StorageV1beta1Api -sidebar_label: StorageV1beta1Api -sidebar_position: 11 ---- -# StorageV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#createVolumeAttributesClass) | **POST** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**deleteCollectionVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#deleteCollectionVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**deleteVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#deleteVolumeAttributesClass) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/StorageV1beta1Api#getAPIResources) | **GET** /apis/storage.k8s.io/v1beta1/ | -[**listVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#listVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses | -[**patchVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#patchVolumeAttributesClass) | **PATCH** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**readVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#readVolumeAttributesClass) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | -[**replaceVolumeAttributesClass**](/docs/api-reference/configuration-storage/StorageV1beta1Api#replaceVolumeAttributesClass) | **PUT** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} | - -### createVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass createVolumeAttributesClass(body) - -create a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiCreateVolumeAttributesClassRequest = { - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1VolumeAttributesClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionVolumeAttributesClass - - - -> V1Status deleteCollectionVolumeAttributesClass() - -delete collection of VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiDeleteCollectionVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass deleteVolumeAttributesClass() - -delete a VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiDeleteVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listVolumeAttributesClass - - - -> V1beta1VolumeAttributesClassList listVolumeAttributesClass() - -list or watch objects of kind VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiListVolumeAttributesClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass patchVolumeAttributesClass(body) - -partially update the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiPatchVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass readVolumeAttributesClass() - -read the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiReadVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceVolumeAttributesClass - - - -> V1beta1VolumeAttributesClass replaceVolumeAttributesClass(body) - -replace the specified VolumeAttributesClass - -### Example - - -```typescript -import { createConfiguration, StorageV1beta1Api } from '@kubernetes/client-node'; -import type { StorageV1beta1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StorageV1beta1Api(configuration); - -const request: StorageV1beta1ApiReplaceVolumeAttributesClassRequest = { - // name of the VolumeAttributesClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - driverName: "driverName_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - parameters: { - "key": "key_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceVolumeAttributesClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1VolumeAttributesClass**| | - **name** | [**string**] | name of the VolumeAttributesClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1VolumeAttributesClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationApi.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationApi.md deleted file mode 100644 index c5297ac8c14..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: StoragemigrationApi -title: StoragemigrationApi -sidebar_label: StoragemigrationApi -sidebar_position: 8 ---- -# StoragemigrationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/configuration-storage/StoragemigrationApi#getAPIGroup) | **GET** /apis/storagemigration.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, StoragemigrationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationV1beta1Api.md deleted file mode 100644 index 00238d62246..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/StoragemigrationV1beta1Api.md +++ /dev/null @@ -1,1016 +0,0 @@ ---- -id: StoragemigrationV1beta1Api -title: StoragemigrationV1beta1Api -sidebar_label: StoragemigrationV1beta1Api -sidebar_position: 9 ---- -# StoragemigrationV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#createStorageVersionMigration) | **POST** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**deleteCollectionStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#deleteCollectionStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**deleteStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#deleteStorageVersionMigration) | **DELETE** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**getAPIResources**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#getAPIResources) | **GET** /apis/storagemigration.k8s.io/v1beta1/ | -[**listStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#listStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations | -[**patchStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#patchStorageVersionMigration) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**patchStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#patchStorageVersionMigrationStatus) | **PATCH** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | -[**readStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#readStorageVersionMigration) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**readStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#readStorageVersionMigrationStatus) | **GET** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | -[**replaceStorageVersionMigration**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#replaceStorageVersionMigration) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name} | -[**replaceStorageVersionMigrationStatus**](/docs/api-reference/configuration-storage/StoragemigrationV1beta1Api#replaceStorageVersionMigrationStatus) | **PUT** /apis/storagemigration.k8s.io/v1beta1/storageversionmigrations/{name}/status | - -### createStorageVersionMigration - - - -> V1beta1StorageVersionMigration createStorageVersionMigration(body) - -create a StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiCreateStorageVersionMigrationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionStorageVersionMigration - - - -> V1Status deleteCollectionStorageVersionMigration() - -delete collection of StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiDeleteCollectionStorageVersionMigrationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteStorageVersionMigration - - - -> V1Status deleteStorageVersionMigration() - -delete a StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiDeleteStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listStorageVersionMigration - - - -> V1beta1StorageVersionMigrationList listStorageVersionMigration() - -list or watch objects of kind StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiListStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiListStorageVersionMigrationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigrationList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchStorageVersionMigration - - - -> V1beta1StorageVersionMigration patchStorageVersionMigration(body) - -partially update the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchStorageVersionMigrationStatus - - - -> V1beta1StorageVersionMigration patchStorageVersionMigrationStatus(body) - -partially update status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiPatchStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readStorageVersionMigration - - - -> V1beta1StorageVersionMigration readStorageVersionMigration() - -read the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readStorageVersionMigrationStatus - - - -> V1beta1StorageVersionMigration readStorageVersionMigrationStatus() - -read status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReadStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceStorageVersionMigration - - - -> V1beta1StorageVersionMigration replaceStorageVersionMigration(body) - -replace the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionMigration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceStorageVersionMigrationStatus - - - -> V1beta1StorageVersionMigration replaceStorageVersionMigrationStatus(body) - -replace status of the specified StorageVersionMigration - -### Example - - -```typescript -import { createConfiguration, StoragemigrationV1beta1Api } from '@kubernetes/client-node'; -import type { StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new StoragemigrationV1beta1Api(configuration); - -const request: StoragemigrationV1beta1ApiReplaceStorageVersionMigrationStatusRequest = { - // name of the StorageVersionMigration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - resource: { - group: "group_example", - resource: "resource_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - resourceVersion: "resourceVersion_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionMigrationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1StorageVersionMigration**| | - **name** | [**string**] | name of the StorageVersionMigration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1StorageVersionMigration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/_category_.json deleted file mode 100644 index 6723fe67c06..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/configuration-storage/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Configuration & Storage", - "position": 5 -} diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreApi.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreApi.md deleted file mode 100644 index 23689cf7d5a..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: CoreApi -title: CoreApi -sidebar_label: CoreApi -sidebar_position: 1 ---- -# CoreApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIVersions**](/docs/api-reference/core-resources/CoreApi#getAPIVersions) | **GET** /api/ | - -### getAPIVersions - - - -> V1APIVersions getAPIVersions() - -get available API versions - -### Example - - -```typescript -import { createConfiguration, CoreApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIVersions(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIVersions - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreV1Api.md deleted file mode 100644 index 13ef8d9adec..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/core-resources/CoreV1Api.md +++ /dev/null @@ -1,39221 +0,0 @@ ---- -id: CoreV1Api -title: CoreV1Api -sidebar_label: CoreV1Api -sidebar_position: 2 ---- -# CoreV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**connectDeleteNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedPodProxy) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectDeleteNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedPodProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectDeleteNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedServiceProxy) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectDeleteNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNamespacedServiceProxyWithPath) | **DELETE** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectDeleteNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNodeProxy) | **DELETE** /api/v1/nodes/{name}/proxy | -[**connectDeleteNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectDeleteNodeProxyWithPath) | **DELETE** /api/v1/nodes/{name}/proxy/{path} | -[**connectGetNamespacedPodAttach**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodAttach) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/attach | -[**connectGetNamespacedPodExec**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodExec) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/exec | -[**connectGetNamespacedPodPortforward**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodPortforward) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/portforward | -[**connectGetNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodProxy) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectGetNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedPodProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectGetNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedServiceProxy) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectGetNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNamespacedServiceProxyWithPath) | **GET** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectGetNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectGetNodeProxy) | **GET** /api/v1/nodes/{name}/proxy | -[**connectGetNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectGetNodeProxyWithPath) | **GET** /api/v1/nodes/{name}/proxy/{path} | -[**connectHeadNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedPodProxy) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectHeadNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedPodProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectHeadNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedServiceProxy) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectHeadNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNamespacedServiceProxyWithPath) | **HEAD** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectHeadNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNodeProxy) | **HEAD** /api/v1/nodes/{name}/proxy | -[**connectHeadNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectHeadNodeProxyWithPath) | **HEAD** /api/v1/nodes/{name}/proxy/{path} | -[**connectOptionsNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedPodProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectOptionsNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedPodProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectOptionsNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedServiceProxy) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectOptionsNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNamespacedServiceProxyWithPath) | **OPTIONS** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectOptionsNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNodeProxy) | **OPTIONS** /api/v1/nodes/{name}/proxy | -[**connectOptionsNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectOptionsNodeProxyWithPath) | **OPTIONS** /api/v1/nodes/{name}/proxy/{path} | -[**connectPatchNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedPodProxy) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPatchNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedPodProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPatchNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedServiceProxy) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPatchNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNamespacedServiceProxyWithPath) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPatchNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNodeProxy) | **PATCH** /api/v1/nodes/{name}/proxy | -[**connectPatchNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPatchNodeProxyWithPath) | **PATCH** /api/v1/nodes/{name}/proxy/{path} | -[**connectPostNamespacedPodAttach**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodAttach) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/attach | -[**connectPostNamespacedPodExec**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodExec) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/exec | -[**connectPostNamespacedPodPortforward**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodPortforward) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/portforward | -[**connectPostNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodProxy) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPostNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedPodProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPostNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedServiceProxy) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPostNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNamespacedServiceProxyWithPath) | **POST** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPostNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPostNodeProxy) | **POST** /api/v1/nodes/{name}/proxy | -[**connectPostNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPostNodeProxyWithPath) | **POST** /api/v1/nodes/{name}/proxy/{path} | -[**connectPutNamespacedPodProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedPodProxy) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy | -[**connectPutNamespacedPodProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedPodProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | -[**connectPutNamespacedServiceProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedServiceProxy) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy | -[**connectPutNamespacedServiceProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNamespacedServiceProxyWithPath) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | -[**connectPutNodeProxy**](/docs/api-reference/core-resources/CoreV1Api#connectPutNodeProxy) | **PUT** /api/v1/nodes/{name}/proxy | -[**connectPutNodeProxyWithPath**](/docs/api-reference/core-resources/CoreV1Api#connectPutNodeProxyWithPath) | **PUT** /api/v1/nodes/{name}/proxy/{path} | -[**createNamespace**](/docs/api-reference/core-resources/CoreV1Api#createNamespace) | **POST** /api/v1/namespaces | -[**createNamespacedBinding**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedBinding) | **POST** /api/v1/namespaces/{namespace}/bindings | -[**createNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedConfigMap) | **POST** /api/v1/namespaces/{namespace}/configmaps | -[**createNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedEndpoints) | **POST** /api/v1/namespaces/{namespace}/endpoints | -[**createNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedEvent) | **POST** /api/v1/namespaces/{namespace}/events | -[**createNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedLimitRange) | **POST** /api/v1/namespaces/{namespace}/limitranges | -[**createNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPersistentVolumeClaim) | **POST** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**createNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPod) | **POST** /api/v1/namespaces/{namespace}/pods | -[**createNamespacedPodBinding**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodBinding) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/binding | -[**createNamespacedPodEviction**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodEviction) | **POST** /api/v1/namespaces/{namespace}/pods/{name}/eviction | -[**createNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedPodTemplate) | **POST** /api/v1/namespaces/{namespace}/podtemplates | -[**createNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedReplicationController) | **POST** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**createNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedResourceQuota) | **POST** /api/v1/namespaces/{namespace}/resourcequotas | -[**createNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedSecret) | **POST** /api/v1/namespaces/{namespace}/secrets | -[**createNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedService) | **POST** /api/v1/namespaces/{namespace}/services | -[**createNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedServiceAccount) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts | -[**createNamespacedServiceAccountToken**](/docs/api-reference/core-resources/CoreV1Api#createNamespacedServiceAccountToken) | **POST** /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token | -[**createNode**](/docs/api-reference/core-resources/CoreV1Api#createNode) | **POST** /api/v1/nodes | -[**createPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#createPersistentVolume) | **POST** /api/v1/persistentvolumes | -[**deleteCollectionNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps | -[**deleteCollectionNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints | -[**deleteCollectionNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events | -[**deleteCollectionNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges | -[**deleteCollectionNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**deleteCollectionNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods | -[**deleteCollectionNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates | -[**deleteCollectionNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**deleteCollectionNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas | -[**deleteCollectionNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets | -[**deleteCollectionNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services | -[**deleteCollectionNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts | -[**deleteCollectionNode**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionNode) | **DELETE** /api/v1/nodes | -[**deleteCollectionPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#deleteCollectionPersistentVolume) | **DELETE** /api/v1/persistentvolumes | -[**deleteNamespace**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespace) | **DELETE** /api/v1/namespaces/{name} | -[**deleteNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedConfigMap) | **DELETE** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**deleteNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedEndpoints) | **DELETE** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**deleteNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedEvent) | **DELETE** /api/v1/namespaces/{namespace}/events/{name} | -[**deleteNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedLimitRange) | **DELETE** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**deleteNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPersistentVolumeClaim) | **DELETE** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**deleteNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPod) | **DELETE** /api/v1/namespaces/{namespace}/pods/{name} | -[**deleteNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedPodTemplate) | **DELETE** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**deleteNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedReplicationController) | **DELETE** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**deleteNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedResourceQuota) | **DELETE** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**deleteNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedSecret) | **DELETE** /api/v1/namespaces/{namespace}/secrets/{name} | -[**deleteNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedService) | **DELETE** /api/v1/namespaces/{namespace}/services/{name} | -[**deleteNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#deleteNamespacedServiceAccount) | **DELETE** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**deleteNode**](/docs/api-reference/core-resources/CoreV1Api#deleteNode) | **DELETE** /api/v1/nodes/{name} | -[**deletePersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#deletePersistentVolume) | **DELETE** /api/v1/persistentvolumes/{name} | -[**getAPIResources**](/docs/api-reference/core-resources/CoreV1Api#getAPIResources) | **GET** /api/v1/ | -[**listComponentStatus**](/docs/api-reference/core-resources/CoreV1Api#listComponentStatus) | **GET** /api/v1/componentstatuses | -[**listConfigMapForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listConfigMapForAllNamespaces) | **GET** /api/v1/configmaps | -[**listEndpointsForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listEndpointsForAllNamespaces) | **GET** /api/v1/endpoints | -[**listEventForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listEventForAllNamespaces) | **GET** /api/v1/events | -[**listLimitRangeForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listLimitRangeForAllNamespaces) | **GET** /api/v1/limitranges | -[**listNamespace**](/docs/api-reference/core-resources/CoreV1Api#listNamespace) | **GET** /api/v1/namespaces | -[**listNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps | -[**listNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints | -[**listNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events | -[**listNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges | -[**listNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims | -[**listNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods | -[**listNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates | -[**listNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers | -[**listNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas | -[**listNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets | -[**listNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services | -[**listNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#listNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts | -[**listNode**](/docs/api-reference/core-resources/CoreV1Api#listNode) | **GET** /api/v1/nodes | -[**listPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#listPersistentVolume) | **GET** /api/v1/persistentvolumes | -[**listPersistentVolumeClaimForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPersistentVolumeClaimForAllNamespaces) | **GET** /api/v1/persistentvolumeclaims | -[**listPodForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPodForAllNamespaces) | **GET** /api/v1/pods | -[**listPodTemplateForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listPodTemplateForAllNamespaces) | **GET** /api/v1/podtemplates | -[**listReplicationControllerForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listReplicationControllerForAllNamespaces) | **GET** /api/v1/replicationcontrollers | -[**listResourceQuotaForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listResourceQuotaForAllNamespaces) | **GET** /api/v1/resourcequotas | -[**listSecretForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listSecretForAllNamespaces) | **GET** /api/v1/secrets | -[**listServiceAccountForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listServiceAccountForAllNamespaces) | **GET** /api/v1/serviceaccounts | -[**listServiceForAllNamespaces**](/docs/api-reference/core-resources/CoreV1Api#listServiceForAllNamespaces) | **GET** /api/v1/services | -[**patchNamespace**](/docs/api-reference/core-resources/CoreV1Api#patchNamespace) | **PATCH** /api/v1/namespaces/{name} | -[**patchNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespaceStatus) | **PATCH** /api/v1/namespaces/{name}/status | -[**patchNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedConfigMap) | **PATCH** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**patchNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedEndpoints) | **PATCH** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**patchNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedEvent) | **PATCH** /api/v1/namespaces/{namespace}/events/{name} | -[**patchNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedLimitRange) | **PATCH** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**patchNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPersistentVolumeClaim) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**patchNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPersistentVolumeClaimStatus) | **PATCH** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**patchNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPod) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name} | -[**patchNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodEphemeralcontainers) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**patchNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodResize) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**patchNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodStatus) | **PATCH** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**patchNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedPodTemplate) | **PATCH** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**patchNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationController) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**patchNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationControllerScale) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**patchNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedReplicationControllerStatus) | **PATCH** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**patchNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedResourceQuota) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**patchNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedResourceQuotaStatus) | **PATCH** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**patchNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedSecret) | **PATCH** /api/v1/namespaces/{namespace}/secrets/{name} | -[**patchNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedService) | **PATCH** /api/v1/namespaces/{namespace}/services/{name} | -[**patchNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedServiceAccount) | **PATCH** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**patchNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNamespacedServiceStatus) | **PATCH** /api/v1/namespaces/{namespace}/services/{name}/status | -[**patchNode**](/docs/api-reference/core-resources/CoreV1Api#patchNode) | **PATCH** /api/v1/nodes/{name} | -[**patchNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#patchNodeStatus) | **PATCH** /api/v1/nodes/{name}/status | -[**patchPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#patchPersistentVolume) | **PATCH** /api/v1/persistentvolumes/{name} | -[**patchPersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#patchPersistentVolumeStatus) | **PATCH** /api/v1/persistentvolumes/{name}/status | -[**readComponentStatus**](/docs/api-reference/core-resources/CoreV1Api#readComponentStatus) | **GET** /api/v1/componentstatuses/{name} | -[**readNamespace**](/docs/api-reference/core-resources/CoreV1Api#readNamespace) | **GET** /api/v1/namespaces/{name} | -[**readNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespaceStatus) | **GET** /api/v1/namespaces/{name}/status | -[**readNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedConfigMap) | **GET** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**readNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedEndpoints) | **GET** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**readNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedEvent) | **GET** /api/v1/namespaces/{namespace}/events/{name} | -[**readNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedLimitRange) | **GET** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**readNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPersistentVolumeClaim) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**readNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPersistentVolumeClaimStatus) | **GET** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**readNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPod) | **GET** /api/v1/namespaces/{namespace}/pods/{name} | -[**readNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodEphemeralcontainers) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**readNamespacedPodLog**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodLog) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/log | -[**readNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodResize) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**readNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodStatus) | **GET** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**readNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedPodTemplate) | **GET** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**readNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationController) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**readNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationControllerScale) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**readNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedReplicationControllerStatus) | **GET** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**readNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedResourceQuota) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**readNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedResourceQuotaStatus) | **GET** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**readNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedSecret) | **GET** /api/v1/namespaces/{namespace}/secrets/{name} | -[**readNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedService) | **GET** /api/v1/namespaces/{namespace}/services/{name} | -[**readNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedServiceAccount) | **GET** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**readNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#readNamespacedServiceStatus) | **GET** /api/v1/namespaces/{namespace}/services/{name}/status | -[**readNode**](/docs/api-reference/core-resources/CoreV1Api#readNode) | **GET** /api/v1/nodes/{name} | -[**readNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#readNodeStatus) | **GET** /api/v1/nodes/{name}/status | -[**readPersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#readPersistentVolume) | **GET** /api/v1/persistentvolumes/{name} | -[**readPersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#readPersistentVolumeStatus) | **GET** /api/v1/persistentvolumes/{name}/status | -[**replaceNamespace**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespace) | **PUT** /api/v1/namespaces/{name} | -[**replaceNamespaceFinalize**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespaceFinalize) | **PUT** /api/v1/namespaces/{name}/finalize | -[**replaceNamespaceStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespaceStatus) | **PUT** /api/v1/namespaces/{name}/status | -[**replaceNamespacedConfigMap**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedConfigMap) | **PUT** /api/v1/namespaces/{namespace}/configmaps/{name} | -[**replaceNamespacedEndpoints**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedEndpoints) | **PUT** /api/v1/namespaces/{namespace}/endpoints/{name} | -[**replaceNamespacedEvent**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedEvent) | **PUT** /api/v1/namespaces/{namespace}/events/{name} | -[**replaceNamespacedLimitRange**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedLimitRange) | **PUT** /api/v1/namespaces/{namespace}/limitranges/{name} | -[**replaceNamespacedPersistentVolumeClaim**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPersistentVolumeClaim) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | -[**replaceNamespacedPersistentVolumeClaimStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPersistentVolumeClaimStatus) | **PUT** /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | -[**replaceNamespacedPod**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPod) | **PUT** /api/v1/namespaces/{namespace}/pods/{name} | -[**replaceNamespacedPodEphemeralcontainers**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodEphemeralcontainers) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers | -[**replaceNamespacedPodResize**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodResize) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/resize | -[**replaceNamespacedPodStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodStatus) | **PUT** /api/v1/namespaces/{namespace}/pods/{name}/status | -[**replaceNamespacedPodTemplate**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedPodTemplate) | **PUT** /api/v1/namespaces/{namespace}/podtemplates/{name} | -[**replaceNamespacedReplicationController**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationController) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | -[**replaceNamespacedReplicationControllerScale**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationControllerScale) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | -[**replaceNamespacedReplicationControllerStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedReplicationControllerStatus) | **PUT** /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | -[**replaceNamespacedResourceQuota**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedResourceQuota) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name} | -[**replaceNamespacedResourceQuotaStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedResourceQuotaStatus) | **PUT** /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | -[**replaceNamespacedSecret**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedSecret) | **PUT** /api/v1/namespaces/{namespace}/secrets/{name} | -[**replaceNamespacedService**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedService) | **PUT** /api/v1/namespaces/{namespace}/services/{name} | -[**replaceNamespacedServiceAccount**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedServiceAccount) | **PUT** /api/v1/namespaces/{namespace}/serviceaccounts/{name} | -[**replaceNamespacedServiceStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNamespacedServiceStatus) | **PUT** /api/v1/namespaces/{namespace}/services/{name}/status | -[**replaceNode**](/docs/api-reference/core-resources/CoreV1Api#replaceNode) | **PUT** /api/v1/nodes/{name} | -[**replaceNodeStatus**](/docs/api-reference/core-resources/CoreV1Api#replaceNodeStatus) | **PUT** /api/v1/nodes/{name}/status | -[**replacePersistentVolume**](/docs/api-reference/core-resources/CoreV1Api#replacePersistentVolume) | **PUT** /api/v1/persistentvolumes/{name} | -[**replacePersistentVolumeStatus**](/docs/api-reference/core-resources/CoreV1Api#replacePersistentVolumeStatus) | **PUT** /api/v1/persistentvolumes/{name}/status | - -### connectDeleteNamespacedPodProxy - - - -> string connectDeleteNamespacedPodProxy() - -connect DELETE requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNamespacedPodProxyWithPath - - - -> string connectDeleteNamespacedPodProxyWithPath() - -connect DELETE requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNamespacedServiceProxy - - - -> string connectDeleteNamespacedServiceProxy() - -connect DELETE requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNamespacedServiceProxyWithPath - - - -> string connectDeleteNamespacedServiceProxyWithPath() - -connect DELETE requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNodeProxy - - - -> string connectDeleteNodeProxy() - -connect DELETE requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectDeleteNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectDeleteNodeProxyWithPath - - - -> string connectDeleteNodeProxyWithPath() - -connect DELETE requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectDeleteNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectDeleteNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectDeleteNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodAttach - - - -> string connectGetNamespacedPodAttach() - -connect GET requests to attach of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodAttachRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodAttachRequest = { - // name of the PodAttachOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) - stderr: true, - // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectGetNamespacedPodAttach(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodAttachOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodExec - - - -> string connectGetNamespacedPodExec() - -connect GET requests to exec of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodExecRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodExecRequest = { - // name of the PodExecOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Command is the remote command to execute. argv array. Not executed within a shell. (optional) - command: "command_example", - // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Redirect the standard error stream of the pod for this call. (optional) - stderr: true, - // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Redirect the standard output stream of the pod for this call. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectGetNamespacedPodExec(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodExecOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined - **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined - **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodPortforward - - - -> string connectGetNamespacedPodPortforward() - -connect GET requests to portforward of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodPortforwardRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodPortforwardRequest = { - // name of the PodPortForwardOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // List of ports to forward Required when using WebSockets (optional) - ports: 1, -}; - -const data = await apiInstance.connectGetNamespacedPodPortforward(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodProxy - - - -> string connectGetNamespacedPodProxy() - -connect GET requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedPodProxyWithPath - - - -> string connectGetNamespacedPodProxyWithPath() - -connect GET requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedServiceProxy - - - -> string connectGetNamespacedServiceProxy() - -connect GET requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNamespacedServiceProxyWithPath - - - -> string connectGetNamespacedServiceProxyWithPath() - -connect GET requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNodeProxy - - - -> string connectGetNodeProxy() - -connect GET requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectGetNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectGetNodeProxyWithPath - - - -> string connectGetNodeProxyWithPath() - -connect GET requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectGetNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectGetNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectGetNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNamespacedPodProxy - - - -> string connectHeadNamespacedPodProxy() - -connect HEAD requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNamespacedPodProxyWithPath - - - -> string connectHeadNamespacedPodProxyWithPath() - -connect HEAD requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNamespacedServiceProxy - - - -> string connectHeadNamespacedServiceProxy() - -connect HEAD requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNamespacedServiceProxyWithPath - - - -> string connectHeadNamespacedServiceProxyWithPath() - -connect HEAD requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNodeProxy - - - -> string connectHeadNodeProxy() - -connect HEAD requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectHeadNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectHeadNodeProxyWithPath - - - -> string connectHeadNodeProxyWithPath() - -connect HEAD requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectHeadNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectHeadNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectHeadNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNamespacedPodProxy - - - -> string connectOptionsNamespacedPodProxy() - -connect OPTIONS requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNamespacedPodProxyWithPath - - - -> string connectOptionsNamespacedPodProxyWithPath() - -connect OPTIONS requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNamespacedServiceProxy - - - -> string connectOptionsNamespacedServiceProxy() - -connect OPTIONS requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNamespacedServiceProxyWithPath - - - -> string connectOptionsNamespacedServiceProxyWithPath() - -connect OPTIONS requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNodeProxy - - - -> string connectOptionsNodeProxy() - -connect OPTIONS requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectOptionsNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectOptionsNodeProxyWithPath - - - -> string connectOptionsNodeProxyWithPath() - -connect OPTIONS requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectOptionsNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectOptionsNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectOptionsNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNamespacedPodProxy - - - -> string connectPatchNamespacedPodProxy() - -connect PATCH requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNamespacedPodProxyWithPath - - - -> string connectPatchNamespacedPodProxyWithPath() - -connect PATCH requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNamespacedServiceProxy - - - -> string connectPatchNamespacedServiceProxy() - -connect PATCH requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNamespacedServiceProxyWithPath - - - -> string connectPatchNamespacedServiceProxyWithPath() - -connect PATCH requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNodeProxy - - - -> string connectPatchNodeProxy() - -connect PATCH requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPatchNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPatchNodeProxyWithPath - - - -> string connectPatchNodeProxyWithPath() - -connect PATCH requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPatchNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPatchNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPatchNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodAttach - - - -> string connectPostNamespacedPodAttach() - -connect POST requests to attach of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodAttachRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodAttachRequest = { - // name of the PodAttachOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional) - stderr: true, - // Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectPostNamespacedPodAttach(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodAttachOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **stdin** | [**boolean**] | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodExec - - - -> string connectPostNamespacedPodExec() - -connect POST requests to exec of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodExecRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodExecRequest = { - // name of the PodExecOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Command is the remote command to execute. argv array. Not executed within a shell. (optional) - command: "command_example", - // Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional) - container: "container_example", - // Redirect the standard error stream of the pod for this call. (optional) - stderr: true, - // Redirect the standard input stream of the pod for this call. Defaults to false. (optional) - stdin: true, - // Redirect the standard output stream of the pod for this call. (optional) - stdout: true, - // TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional) - tty: true, -}; - -const data = await apiInstance.connectPostNamespacedPodExec(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodExecOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **command** | [**string**] | Command is the remote command to execute. argv array. Not executed within a shell. | (optional) defaults to undefined - **container** | [**string**] | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | (optional) defaults to undefined - **stderr** | [**boolean**] | Redirect the standard error stream of the pod for this call. | (optional) defaults to undefined - **stdin** | [**boolean**] | Redirect the standard input stream of the pod for this call. Defaults to false. | (optional) defaults to undefined - **stdout** | [**boolean**] | Redirect the standard output stream of the pod for this call. | (optional) defaults to undefined - **tty** | [**boolean**] | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodPortforward - - - -> string connectPostNamespacedPodPortforward() - -connect POST requests to portforward of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodPortforwardRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodPortforwardRequest = { - // name of the PodPortForwardOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // List of ports to forward Required when using WebSockets (optional) - ports: 1, -}; - -const data = await apiInstance.connectPostNamespacedPodPortforward(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodPortForwardOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **ports** | [**number**] | List of ports to forward Required when using WebSockets | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodProxy - - - -> string connectPostNamespacedPodProxy() - -connect POST requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedPodProxyWithPath - - - -> string connectPostNamespacedPodProxyWithPath() - -connect POST requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedServiceProxy - - - -> string connectPostNamespacedServiceProxy() - -connect POST requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNamespacedServiceProxyWithPath - - - -> string connectPostNamespacedServiceProxyWithPath() - -connect POST requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNodeProxy - - - -> string connectPostNodeProxy() - -connect POST requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPostNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPostNodeProxyWithPath - - - -> string connectPostNodeProxyWithPath() - -connect POST requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPostNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPostNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPostNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNamespacedPodProxy - - - -> string connectPutNamespacedPodProxy() - -connect PUT requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNamespacedPodProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedPodProxyRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedPodProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNamespacedPodProxyWithPath - - - -> string connectPutNamespacedPodProxyWithPath() - -connect PUT requests to proxy of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedPodProxyWithPathRequest = { - // name of the PodProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to pod. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedPodProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to pod. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNamespacedServiceProxy - - - -> string connectPutNamespacedServiceProxy() - -connect PUT requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNamespacedServiceProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedServiceProxyRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedServiceProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNamespacedServiceProxyWithPath - - - -> string connectPutNamespacedServiceProxyWithPath() - -connect PUT requests to proxy of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNamespacedServiceProxyWithPathRequest = { - // name of the ServiceProxyOptions - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // path to the resource - path: "path_example", - // Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNamespacedServiceProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceProxyOptions | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNodeProxy - - - -> string connectPutNodeProxy() - -connect PUT requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNodeProxyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNodeProxyRequest = { - // name of the NodeProxyOptions - name: "name_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path: "path_example", -}; - -const data = await apiInstance.connectPutNodeProxy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### connectPutNodeProxyWithPath - - - -> string connectPutNodeProxyWithPath() - -connect PUT requests to proxy of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiConnectPutNodeProxyWithPathRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiConnectPutNodeProxyWithPathRequest = { - // name of the NodeProxyOptions - name: "name_example", - // path to the resource - path: "path_example", - // Path is the URL path to use for the current proxy request to node. (optional) - path2: "path_example", -}; - -const data = await apiInstance.connectPutNodeProxyWithPath(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NodeProxyOptions | defaults to undefined - **path** | [**string**] | path to the resource | defaults to undefined - **path2** | [**string**] | Path is the URL path to use for the current proxy request to node. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: */* - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### createNamespace - - - -> V1Namespace createNamespace(body) - -create a Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespaceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedBinding - - - -> V1Binding createNamespacedBinding(body) - -create a Binding - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - target: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Binding**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Binding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedConfigMap - - - -> V1ConfigMap createNamespacedConfigMap(body) - -create a ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - binaryData: { - "key": 'YQ==', - }, - data: { - "key": "key_example", - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ConfigMap**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ConfigMap - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedEndpoints - - - -> V1Endpoints createNamespacedEndpoints(body) - -create Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - subsets: [ - { - addresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - notReadyAddresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Endpoints**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Endpoints - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedEvent - - - -> CoreV1Event createNamespacedEvent(body) - -create an Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - count: 1, - eventTime: "eventTime_example", - firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - involvedObject: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - kind: "kind_example", - lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - reason: "reason_example", - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingComponent: "reportingComponent_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - source: { - component: "component_example", - host: "host_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **CoreV1Event**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -CoreV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedLimitRange - - - -> V1LimitRange createNamespacedLimitRange(body) - -create a LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - limits: [ - { - _default: { - "key": "key_example", - }, - defaultRequest: { - "key": "key_example", - }, - max: { - "key": "key_example", - }, - maxLimitRequestRatio: { - "key": "key_example", - }, - min: { - "key": "key_example", - }, - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LimitRange**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1LimitRange - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim createNamespacedPersistentVolumeClaim(body) - -create a PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPod - - - -> V1Pod createNamespacedPod(body) - -create a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPodBinding - - - -> V1Binding createNamespacedPodBinding(body) - -create binding of a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPodBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodBindingRequest = { - // name of the Binding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - target: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedPodBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Binding**| | - **name** | [**string**] | name of the Binding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Binding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPodEviction - - - -> V1Eviction createNamespacedPodEviction(body) - -create eviction of a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPodEvictionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodEvictionRequest = { - // name of the Eviction - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - deleteOptions: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedPodEviction(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Eviction**| | - **name** | [**string**] | name of the Eviction | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Eviction - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPodTemplate - - - -> V1PodTemplate createNamespacedPodTemplate(body) - -create a PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedReplicationController - - - -> V1ReplicationController createNamespacedReplicationController(body) - -create a ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceQuota - - - -> V1ResourceQuota createNamespacedResourceQuota(body) - -create a ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedSecret - - - -> V1Secret createNamespacedSecret(body) - -create a Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: { - "key": 'YQ==', - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - stringData: { - "key": "key_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Secret**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Secret - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedService - - - -> V1Service createNamespacedService(body) - -create a Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedServiceAccount - - - -> V1ServiceAccount createNamespacedServiceAccount(body) - -create a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - automountServiceAccountToken: true, - imagePullSecrets: [ - { - name: "name_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - secrets: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceAccount**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedServiceAccountToken - - - -> AuthenticationV1TokenRequest createNamespacedServiceAccountToken(body) - -create token of a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNamespacedServiceAccountTokenRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNamespacedServiceAccountTokenRequest = { - // name of the TokenRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - audiences: [ - "audiences_example", - ], - boundObjectRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - expirationSeconds: 1, - }, - status: { - expirationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - token: "token_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedServiceAccountToken(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **AuthenticationV1TokenRequest**| | - **name** | [**string**] | name of the TokenRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -AuthenticationV1TokenRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNode - - - -> V1Node createNode(body) - -create a Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreateNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreateNodeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createPersistentVolume - - - -> V1PersistentVolume createPersistentVolume(body) - -create a PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiCreatePersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiCreatePersistentVolumeRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedConfigMap - - - -> V1Status deleteCollectionNamespacedConfigMap() - -delete collection of ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedEndpoints - - - -> V1Status deleteCollectionNamespacedEndpoints() - -delete collection of Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedEvent - - - -> V1Status deleteCollectionNamespacedEvent() - -delete collection of Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedLimitRange - - - -> V1Status deleteCollectionNamespacedLimitRange() - -delete collection of LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPersistentVolumeClaim - - - -> V1Status deleteCollectionNamespacedPersistentVolumeClaim() - -delete collection of PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPod - - - -> V1Status deleteCollectionNamespacedPod() - -delete collection of Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPodTemplate - - - -> V1Status deleteCollectionNamespacedPodTemplate() - -delete collection of PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedReplicationController - - - -> V1Status deleteCollectionNamespacedReplicationController() - -delete collection of ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceQuota - - - -> V1Status deleteCollectionNamespacedResourceQuota() - -delete collection of ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedSecret - - - -> V1Status deleteCollectionNamespacedSecret() - -delete collection of Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedService - - - -> V1Status deleteCollectionNamespacedService() - -delete collection of Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedServiceAccount - - - -> V1Status deleteCollectionNamespacedServiceAccount() - -delete collection of ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNode - - - -> V1Status deleteCollectionNode() - -delete collection of Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionNodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionPersistentVolume - - - -> V1Status deleteCollectionPersistentVolume() - -delete collection of PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteCollectionPersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteCollectionPersistentVolumeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespace - - - -> V1Status deleteNamespace() - -delete a Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespaceRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedConfigMap - - - -> V1Status deleteNamespacedConfigMap() - -delete a ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedEndpoints - - - -> V1Status deleteNamespacedEndpoints() - -delete Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedEvent - - - -> V1Status deleteNamespacedEvent() - -delete an Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedLimitRange - - - -> V1Status deleteNamespacedLimitRange() - -delete a LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim deleteNamespacedPersistentVolumeClaim() - -delete a PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedPod - - - -> V1Pod deleteNamespacedPod() - -delete a Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedPodTemplate - - - -> V1PodTemplate deleteNamespacedPodTemplate() - -delete a PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedReplicationController - - - -> V1Status deleteNamespacedReplicationController() - -delete a ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceQuota - - - -> V1ResourceQuota deleteNamespacedResourceQuota() - -delete a ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedSecret - - - -> V1Status deleteNamespacedSecret() - -delete a Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedService - - - -> V1Service deleteNamespacedService() - -delete a Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedServiceAccount - - - -> V1ServiceAccount deleteNamespacedServiceAccount() - -delete a ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNode - - - -> V1Status deleteNode() - -delete a Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeleteNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeleteNodeRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deletePersistentVolume - - - -> V1PersistentVolume deletePersistentVolume() - -delete a PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiDeletePersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiDeletePersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listComponentStatus - - - -> V1ComponentStatusList listComponentStatus() - -list objects of kind ComponentStatus - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListComponentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListComponentStatusRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listComponentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ComponentStatusList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listConfigMapForAllNamespaces - - - -> V1ConfigMapList listConfigMapForAllNamespaces() - -list or watch objects of kind ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListConfigMapForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListConfigMapForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listConfigMapForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ConfigMapList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listEndpointsForAllNamespaces - - - -> V1EndpointsList listEndpointsForAllNamespaces() - -list or watch objects of kind Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListEndpointsForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListEndpointsForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEndpointsForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1EndpointsList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listEventForAllNamespaces - - - -> CoreV1EventList listEventForAllNamespaces() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListEventForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListEventForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEventForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -CoreV1EventList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listLimitRangeForAllNamespaces - - - -> V1LimitRangeList listLimitRangeForAllNamespaces() - -list or watch objects of kind LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListLimitRangeForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListLimitRangeForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listLimitRangeForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1LimitRangeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespace - - - -> V1NamespaceList listNamespace() - -list or watch objects of kind Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespaceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1NamespaceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedConfigMap - - - -> V1ConfigMapList listNamespacedConfigMap() - -list or watch objects of kind ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedConfigMapRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ConfigMapList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedEndpoints - - - -> V1EndpointsList listNamespacedEndpoints() - -list or watch objects of kind Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedEndpointsRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1EndpointsList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedEvent - - - -> CoreV1EventList listNamespacedEvent() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -CoreV1EventList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedLimitRange - - - -> V1LimitRangeList listNamespacedLimitRange() - -list or watch objects of kind LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedLimitRangeRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1LimitRangeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaimList listNamespacedPersistentVolumeClaim() - -list or watch objects of kind PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPersistentVolumeClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPod - - - -> V1PodList listNamespacedPod() - -list or watch objects of kind Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPodRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPodTemplate - - - -> V1PodTemplateList listNamespacedPodTemplate() - -list or watch objects of kind PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedPodTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedReplicationController - - - -> V1ReplicationControllerList listNamespacedReplicationController() - -list or watch objects of kind ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedReplicationControllerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ReplicationControllerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceQuota - - - -> V1ResourceQuotaList listNamespacedResourceQuota() - -list or watch objects of kind ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedResourceQuotaRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceQuotaList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedSecret - - - -> V1SecretList listNamespacedSecret() - -list or watch objects of kind Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedSecretRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1SecretList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedService - - - -> V1ServiceList listNamespacedService() - -list or watch objects of kind Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedServiceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedServiceAccount - - - -> V1ServiceAccountList listNamespacedServiceAccount() - -list or watch objects of kind ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNamespacedServiceAccountRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceAccountList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNode - - - -> V1NodeList listNode() - -list or watch objects of kind Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListNodeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1NodeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPersistentVolume - - - -> V1PersistentVolumeList listPersistentVolume() - -list or watch objects of kind PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListPersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPersistentVolumeRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPersistentVolumeClaimForAllNamespaces - - - -> V1PersistentVolumeClaimList listPersistentVolumeClaimForAllNamespaces() - -list or watch objects of kind PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPersistentVolumeClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPersistentVolumeClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPodForAllNamespaces - - - -> V1PodList listPodForAllNamespaces() - -list or watch objects of kind Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListPodForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPodForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPodTemplateForAllNamespaces - - - -> V1PodTemplateList listPodTemplateForAllNamespaces() - -list or watch objects of kind PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListPodTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListPodTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PodTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listReplicationControllerForAllNamespaces - - - -> V1ReplicationControllerList listReplicationControllerForAllNamespaces() - -list or watch objects of kind ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListReplicationControllerForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListReplicationControllerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listReplicationControllerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ReplicationControllerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceQuotaForAllNamespaces - - - -> V1ResourceQuotaList listResourceQuotaForAllNamespaces() - -list or watch objects of kind ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListResourceQuotaForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListResourceQuotaForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceQuotaForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceQuotaList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listSecretForAllNamespaces - - - -> V1SecretList listSecretForAllNamespaces() - -list or watch objects of kind Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListSecretForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListSecretForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listSecretForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1SecretList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listServiceAccountForAllNamespaces - - - -> V1ServiceAccountList listServiceAccountForAllNamespaces() - -list or watch objects of kind ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListServiceAccountForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListServiceAccountForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceAccountForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceAccountList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listServiceForAllNamespaces - - - -> V1ServiceList listServiceForAllNamespaces() - -list or watch objects of kind Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiListServiceForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiListServiceForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespace - - - -> V1Namespace patchNamespace(body) - -partially update the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespaceRequest = { - // name of the Namespace - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespaceStatus - - - -> V1Namespace patchNamespaceStatus(body) - -partially update status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespaceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedConfigMap - - - -> V1ConfigMap patchNamespacedConfigMap(body) - -partially update the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ConfigMap - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedEndpoints - - - -> V1Endpoints patchNamespacedEndpoints(body) - -partially update the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Endpoints - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedEvent - - - -> CoreV1Event patchNamespacedEvent(body) - -partially update the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -CoreV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedLimitRange - - - -> V1LimitRange patchNamespacedLimitRange(body) - -partially update the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1LimitRange - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaim(body) - -partially update the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPersistentVolumeClaimStatus - - - -> V1PersistentVolumeClaim patchNamespacedPersistentVolumeClaimStatus(body) - -partially update status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPod - - - -> V1Pod patchNamespacedPod(body) - -partially update the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodEphemeralcontainers - - - -> V1Pod patchNamespacedPodEphemeralcontainers(body) - -partially update ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodResize - - - -> V1Pod patchNamespacedPodResize(body) - -partially update resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodResizeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodStatus - - - -> V1Pod patchNamespacedPodStatus(body) - -partially update status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodTemplate - - - -> V1PodTemplate patchNamespacedPodTemplate(body) - -partially update the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicationController - - - -> V1ReplicationController patchNamespacedReplicationController(body) - -partially update the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicationControllerScale - - - -> V1Scale patchNamespacedReplicationControllerScale(body) - -partially update scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicationControllerStatus - - - -> V1ReplicationController patchNamespacedReplicationControllerStatus(body) - -partially update status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceQuota - - - -> V1ResourceQuota patchNamespacedResourceQuota(body) - -partially update the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceQuotaStatus - - - -> V1ResourceQuota patchNamespacedResourceQuotaStatus(body) - -partially update status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedSecret - - - -> V1Secret patchNamespacedSecret(body) - -partially update the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Secret - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedService - - - -> V1Service patchNamespacedService(body) - -partially update the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedServiceAccount - - - -> V1ServiceAccount patchNamespacedServiceAccount(body) - -partially update the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedServiceStatus - - - -> V1Service patchNamespacedServiceStatus(body) - -partially update status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNamespacedServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNode - - - -> V1Node patchNode(body) - -partially update the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNodeRequest = { - // name of the Node - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNodeStatus - - - -> V1Node patchNodeStatus(body) - -partially update status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchNodeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchNodeStatusRequest = { - // name of the Node - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchPersistentVolume - - - -> V1PersistentVolume patchPersistentVolume(body) - -partially update the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchPersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchPersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchPersistentVolumeStatus - - - -> V1PersistentVolume patchPersistentVolumeStatus(body) - -partially update status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiPatchPersistentVolumeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiPatchPersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readComponentStatus - - - -> V1ComponentStatus readComponentStatus() - -read the specified ComponentStatus - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadComponentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadComponentStatusRequest = { - // name of the ComponentStatus - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readComponentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ComponentStatus | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ComponentStatus - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespace - - - -> V1Namespace readNamespace() - -read the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespaceRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespaceStatus - - - -> V1Namespace readNamespaceStatus() - -read status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespaceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedConfigMap - - - -> V1ConfigMap readNamespacedConfigMap() - -read the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ConfigMap - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedEndpoints - - - -> V1Endpoints readNamespacedEndpoints() - -read the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Endpoints - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedEvent - - - -> CoreV1Event readNamespacedEvent() - -read the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -CoreV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedLimitRange - - - -> V1LimitRange readNamespacedLimitRange() - -read the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1LimitRange - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaim() - -read the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPersistentVolumeClaimStatus - - - -> V1PersistentVolumeClaim readNamespacedPersistentVolumeClaimStatus() - -read status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPod - - - -> V1Pod readNamespacedPod() - -read the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodEphemeralcontainers - - - -> V1Pod readNamespacedPodEphemeralcontainers() - -read ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodLog - - - -> string readNamespacedPodLog() - -read log of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodLogRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodLogRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // The container for which to stream logs. Defaults to only container if there is one container in the pod. (optional) - container: "container_example", - // Follow the log stream of the pod. Defaults to false. (optional) - follow: true, - // insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). (optional) - insecureSkipTLSVerifyBackend: true, - // If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. (optional) - limitBytes: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // Return previous terminated container logs. Defaults to false. (optional) - previous: true, - // A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. (optional) - sinceSeconds: 1, - // Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) - stream: "stream_example", - // If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". (optional) - tailLines: 1, - // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. (optional) - timestamps: true, -}; - -const data = await apiInstance.readNamespacedPodLog(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **container** | [**string**] | The container for which to stream logs. Defaults to only container if there is one container in the pod. | (optional) defaults to undefined - **follow** | [**boolean**] | Follow the log stream of the pod. Defaults to false. | (optional) defaults to undefined - **insecureSkipTLSVerifyBackend** | [**boolean**] | insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver\'s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). | (optional) defaults to undefined - **limitBytes** | [**number**] | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **previous** | [**boolean**] | Return previous terminated container logs. Defaults to false. | (optional) defaults to undefined - **sinceSeconds** | [**number**] | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | (optional) defaults to undefined - **stream** | [**string**] | Specify which container log stream to return to the client. Acceptable values are \"All\", \"Stdout\" and \"Stderr\". If not specified, \"All\" is used, and both stdout and stderr are returned interleaved. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined - **tailLines** | [**number**] | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when \"TailLines\" is specified, \"Stream\" can only be set to nil or \"All\". | (optional) defaults to undefined - **timestamps** | [**boolean**] | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. | (optional) defaults to undefined - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodResize - - - -> V1Pod readNamespacedPodResize() - -read resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodResizeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodStatus - - - -> V1Pod readNamespacedPodStatus() - -read status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodTemplate - - - -> V1PodTemplate readNamespacedPodTemplate() - -read the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicationController - - - -> V1ReplicationController readNamespacedReplicationController() - -read the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicationControllerScale - - - -> V1Scale readNamespacedReplicationControllerScale() - -read scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicationControllerStatus - - - -> V1ReplicationController readNamespacedReplicationControllerStatus() - -read status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceQuota - - - -> V1ResourceQuota readNamespacedResourceQuota() - -read the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceQuotaStatus - - - -> V1ResourceQuota readNamespacedResourceQuotaStatus() - -read status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedSecret - - - -> V1Secret readNamespacedSecret() - -read the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Secret - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedService - - - -> V1Service readNamespacedService() - -read the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedServiceAccount - - - -> V1ServiceAccount readNamespacedServiceAccount() - -read the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedServiceStatus - - - -> V1Service readNamespacedServiceStatus() - -read status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNamespacedServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNode - - - -> V1Node readNode() - -read the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNodeRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNodeStatus - - - -> V1Node readNodeStatus() - -read status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadNodeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadNodeStatusRequest = { - // name of the Node - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readPersistentVolume - - - -> V1PersistentVolume readPersistentVolume() - -read the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadPersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadPersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readPersistentVolumeStatus - - - -> V1PersistentVolume readPersistentVolumeStatus() - -read status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReadPersistentVolumeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReadPersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespace - - - -> V1Namespace replaceNamespace(body) - -replace the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespaceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespace(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespaceFinalize - - - -> V1Namespace replaceNamespaceFinalize(body) - -replace finalize of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespaceFinalizeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceFinalizeRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.replaceNamespaceFinalize(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespaceStatus - - - -> V1Namespace replaceNamespaceStatus(body) - -replace status of the specified Namespace - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespaceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespaceStatusRequest = { - // name of the Namespace - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - finalizers: [ - "finalizers_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespaceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Namespace**| | - **name** | [**string**] | name of the Namespace | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Namespace - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedConfigMap - - - -> V1ConfigMap replaceNamespacedConfigMap(body) - -replace the specified ConfigMap - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedConfigMapRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedConfigMapRequest = { - // name of the ConfigMap - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - binaryData: { - "key": 'YQ==', - }, - data: { - "key": "key_example", - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedConfigMap(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ConfigMap**| | - **name** | [**string**] | name of the ConfigMap | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ConfigMap - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedEndpoints - - - -> V1Endpoints replaceNamespacedEndpoints(body) - -replace the specified Endpoints - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedEndpointsRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedEndpointsRequest = { - // name of the Endpoints - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - subsets: [ - { - addresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - notReadyAddresses: [ - { - hostname: "hostname_example", - ip: "ip_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEndpoints(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Endpoints**| | - **name** | [**string**] | name of the Endpoints | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Endpoints - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedEvent - - - -> CoreV1Event replaceNamespacedEvent(body) - -replace the specified Event - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - count: 1, - eventTime: "eventTime_example", - firstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - involvedObject: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - kind: "kind_example", - lastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - reason: "reason_example", - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingComponent: "reportingComponent_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - source: { - component: "component_example", - host: "host_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **CoreV1Event**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -CoreV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedLimitRange - - - -> V1LimitRange replaceNamespacedLimitRange(body) - -replace the specified LimitRange - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedLimitRangeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedLimitRangeRequest = { - // name of the LimitRange - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - limits: [ - { - _default: { - "key": "key_example", - }, - defaultRequest: { - "key": "key_example", - }, - max: { - "key": "key_example", - }, - maxLimitRequestRatio: { - "key": "key_example", - }, - min: { - "key": "key_example", - }, - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedLimitRange(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LimitRange**| | - **name** | [**string**] | name of the LimitRange | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1LimitRange - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPersistentVolumeClaim - - - -> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaim(body) - -replace the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPersistentVolumeClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPersistentVolumeClaimStatus - - - -> V1PersistentVolumeClaim replaceNamespacedPersistentVolumeClaimStatus(body) - -replace status of the specified PersistentVolumeClaim - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPersistentVolumeClaimStatusRequest = { - // name of the PersistentVolumeClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPersistentVolumeClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolumeClaim**| | - **name** | [**string**] | name of the PersistentVolumeClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolumeClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPod - - - -> V1Pod replaceNamespacedPod(body) - -replace the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPod(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodEphemeralcontainers - - - -> V1Pod replaceNamespacedPodEphemeralcontainers(body) - -replace ephemeralcontainers of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodEphemeralcontainersRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodEphemeralcontainers(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodResize - - - -> V1Pod replaceNamespacedPodResize(body) - -replace resize of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodResizeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodResizeRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodResize(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodStatus - - - -> V1Pod replaceNamespacedPodStatus(body) - -replace status of the specified Pod - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodStatusRequest = { - // name of the Pod - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - status: { - allocatedResources: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - containerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - ephemeralContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - extendedResourceClaimStatus: { - requestMappings: [ - { - containerName: "containerName_example", - requestName: "requestName_example", - resourceName: "resourceName_example", - }, - ], - resourceClaimName: "resourceClaimName_example", - }, - hostIP: "hostIP_example", - hostIPs: [ - { - ip: "ip_example", - }, - ], - initContainerStatuses: [ - { - allocatedResources: { - "key": "key_example", - }, - allocatedResourcesStatus: [ - { - name: "name_example", - resources: [ - { - health: "health_example", - resourceID: "resourceID_example", - }, - ], - }, - ], - containerID: "containerID_example", - image: "image_example", - imageID: "imageID_example", - lastState: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - name: "name_example", - ready: true, - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartCount: 1, - started: true, - state: { - running: { - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - terminated: { - containerID: "containerID_example", - exitCode: 1, - finishedAt: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - signal: 1, - startedAt: new Date('1970-01-01T00:00:00.00Z'), - }, - waiting: { - message: "message_example", - reason: "reason_example", - }, - }, - stopSignal: "stopSignal_example", - user: { - linux: { - gid: 1, - supplementalGroups: [ - 1, - ], - uid: 1, - }, - }, - volumeMounts: [ - { - mountPath: "mountPath_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - }, - ], - }, - ], - message: "message_example", - nominatedNodeName: "nominatedNodeName_example", - observedGeneration: 1, - phase: "phase_example", - podIP: "podIP_example", - podIPs: [ - { - ip: "ip_example", - }, - ], - qosClass: "qosClass_example", - reason: "reason_example", - resize: "resize_example", - resourceClaimStatuses: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - startTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Pod**| | - **name** | [**string**] | name of the Pod | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Pod - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodTemplate - - - -> V1PodTemplate replaceNamespacedPodTemplate(body) - -replace the specified PodTemplate - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedPodTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedPodTemplateRequest = { - // name of the PodTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PodTemplate**| | - **name** | [**string**] | name of the PodTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PodTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicationController - - - -> V1ReplicationController replaceNamespacedReplicationController(body) - -replace the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedReplicationControllerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationController(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicationControllerScale - - - -> V1Scale replaceNamespacedReplicationControllerScale(body) - -replace scale of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationControllerScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicationControllerStatus - - - -> V1ReplicationController replaceNamespacedReplicationControllerStatus(body) - -replace status of the specified ReplicationController - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedReplicationControllerStatusRequest = { - // name of the ReplicationController - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - "key": "key_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicationControllerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicationController**| | - **name** | [**string**] | name of the ReplicationController | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicationController - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceQuota - - - -> V1ResourceQuota replaceNamespacedResourceQuota(body) - -replace the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedResourceQuotaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedResourceQuotaRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceQuota(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceQuotaStatus - - - -> V1ResourceQuota replaceNamespacedResourceQuotaStatus(body) - -replace status of the specified ResourceQuota - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedResourceQuotaStatusRequest = { - // name of the ResourceQuota - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - hard: { - "key": "key_example", - }, - scopeSelector: { - matchExpressions: [ - { - operator: "operator_example", - scopeName: "scopeName_example", - values: [ - "values_example", - ], - }, - ], - }, - scopes: [ - "scopes_example", - ], - }, - status: { - hard: { - "key": "key_example", - }, - used: { - "key": "key_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceQuotaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceQuota**| | - **name** | [**string**] | name of the ResourceQuota | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceQuota - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedSecret - - - -> V1Secret replaceNamespacedSecret(body) - -replace the specified Secret - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedSecretRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedSecretRequest = { - // name of the Secret - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: { - "key": 'YQ==', - }, - immutable: true, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - stringData: { - "key": "key_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedSecret(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Secret**| | - **name** | [**string**] | name of the Secret | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Secret - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedService - - - -> V1Service replaceNamespacedService(body) - -replace the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedServiceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedService(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedServiceAccount - - - -> V1ServiceAccount replaceNamespacedServiceAccount(body) - -replace the specified ServiceAccount - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedServiceAccountRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceAccountRequest = { - // name of the ServiceAccount - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - automountServiceAccountToken: true, - imagePullSecrets: [ - { - name: "name_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - secrets: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedServiceAccount(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceAccount**| | - **name** | [**string**] | name of the ServiceAccount | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceAccount - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedServiceStatus - - - -> V1Service replaceNamespacedServiceStatus(body) - -replace status of the specified Service - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNamespacedServiceStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNamespacedServiceStatusRequest = { - // name of the Service - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allocateLoadBalancerNodePorts: true, - clusterIP: "clusterIP_example", - clusterIPs: [ - "clusterIPs_example", - ], - externalIPs: [ - "externalIPs_example", - ], - externalName: "externalName_example", - externalTrafficPolicy: "externalTrafficPolicy_example", - healthCheckNodePort: 1, - internalTrafficPolicy: "internalTrafficPolicy_example", - ipFamilies: [ - "ipFamilies_example", - ], - ipFamilyPolicy: "ipFamilyPolicy_example", - loadBalancerClass: "loadBalancerClass_example", - loadBalancerIP: "loadBalancerIP_example", - loadBalancerSourceRanges: [ - "loadBalancerSourceRanges_example", - ], - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - nodePort: 1, - port: 1, - protocol: "protocol_example", - targetPort: "targetPort_example", - }, - ], - publishNotReadyAddresses: true, - selector: { - "key": "key_example", - }, - sessionAffinity: "sessionAffinity_example", - sessionAffinityConfig: { - clientIP: { - timeoutSeconds: 1, - }, - }, - trafficDistribution: "trafficDistribution_example", - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ipMode: "ipMode_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedServiceStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Service**| | - **name** | [**string**] | name of the Service | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Service - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNode - - - -> V1Node replaceNode(body) - -replace the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNodeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNodeRequest = { - // name of the Node - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNodeStatus - - - -> V1Node replaceNodeStatus(body) - -replace status of the specified Node - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplaceNodeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplaceNodeStatusRequest = { - // name of the Node - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - configSource: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - externalID: "externalID_example", - podCIDR: "podCIDR_example", - podCIDRs: [ - "podCIDRs_example", - ], - providerID: "providerID_example", - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - unschedulable: true, - }, - status: { - addresses: [ - { - address: "address_example", - type: "type_example", - }, - ], - allocatable: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastHeartbeatTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - config: { - active: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - assigned: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - error: "error_example", - lastKnownGood: { - configMap: { - kubeletConfigKey: "kubeletConfigKey_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - }, - }, - daemonEndpoints: { - kubeletEndpoint: { - Port: 1, - }, - }, - declaredFeatures: [ - "declaredFeatures_example", - ], - features: { - supplementalGroupsPolicy: true, - }, - images: [ - { - names: [ - "names_example", - ], - sizeBytes: 1, - }, - ], - nodeInfo: { - architecture: "architecture_example", - bootID: "bootID_example", - containerRuntimeVersion: "containerRuntimeVersion_example", - kernelVersion: "kernelVersion_example", - kubeProxyVersion: "kubeProxyVersion_example", - kubeletVersion: "kubeletVersion_example", - machineID: "machineID_example", - operatingSystem: "operatingSystem_example", - osImage: "osImage_example", - swap: { - capacity: 1, - }, - systemUUID: "systemUUID_example", - }, - phase: "phase_example", - runtimeHandlers: [ - { - features: { - recursiveReadOnlyMounts: true, - userNamespaces: true, - }, - name: "name_example", - }, - ], - volumesAttached: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumesInUse: [ - "volumesInUse_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNodeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Node**| | - **name** | [**string**] | name of the Node | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Node - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replacePersistentVolume - - - -> V1PersistentVolume replacePersistentVolume(body) - -replace the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplacePersistentVolumeRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplacePersistentVolumeRequest = { - // name of the PersistentVolume - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePersistentVolume(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replacePersistentVolumeStatus - - - -> V1PersistentVolume replacePersistentVolumeStatus(body) - -replace status of the specified PersistentVolume - -### Example - - -```typescript -import { createConfiguration, CoreV1Api } from '@kubernetes/client-node'; -import type { CoreV1ApiReplacePersistentVolumeStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CoreV1Api(configuration); - -const request: CoreV1ApiReplacePersistentVolumeStatusRequest = { - // name of the PersistentVolume - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - secretNamespace: "secretNamespace_example", - shareName: "shareName_example", - }, - capacity: { - "key": "key_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - volumeID: "volumeID_example", - }, - claimRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - csi: { - controllerExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - controllerPublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - driver: "driver_example", - fsType: "fsType_example", - nodeExpandSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodePublishSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - nodeStageSecretRef: { - name: "name_example", - namespace: "namespace_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - volumeHandle: "volumeHandle_example", - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - glusterfs: { - endpoints: "endpoints_example", - endpointsNamespace: "endpointsNamespace_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - targetPortal: "targetPortal_example", - }, - local: { - fsType: "fsType_example", - path: "path_example", - }, - mountOptions: [ - "mountOptions_example", - ], - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - nodeAffinity: { - required: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - persistentVolumeReclaimPolicy: "persistentVolumeReclaimPolicy_example", - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - namespace: "namespace_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - storageClassName: "storageClassName_example", - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - status: { - lastPhaseTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - phase: "phase_example", - reason: "reason_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePersistentVolumeStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PersistentVolume**| | - **name** | [**string**] | name of the PersistentVolume | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PersistentVolume - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsApi.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsApi.md deleted file mode 100644 index 891d445a1e7..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: EventsApi -title: EventsApi -sidebar_label: EventsApi -sidebar_position: 3 ---- -# EventsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/core-resources/EventsApi#getAPIGroup) | **GET** /apis/events.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, EventsApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsV1Api.md deleted file mode 100644 index fd13c6f99c2..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/core-resources/EventsV1Api.md +++ /dev/null @@ -1,889 +0,0 @@ ---- -id: EventsV1Api -title: EventsV1Api -sidebar_label: EventsV1Api -sidebar_position: 4 ---- -# EventsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#createNamespacedEvent) | **POST** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**deleteCollectionNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#deleteCollectionNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**deleteNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#deleteNamespacedEvent) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**getAPIResources**](/docs/api-reference/core-resources/EventsV1Api#getAPIResources) | **GET** /apis/events.k8s.io/v1/ | -[**listEventForAllNamespaces**](/docs/api-reference/core-resources/EventsV1Api#listEventForAllNamespaces) | **GET** /apis/events.k8s.io/v1/events | -[**listNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#listNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events | -[**patchNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#patchNamespacedEvent) | **PATCH** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**readNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#readNamespacedEvent) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | -[**replaceNamespacedEvent**](/docs/api-reference/core-resources/EventsV1Api#replaceNamespacedEvent) | **PUT** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} | - -### createNamespacedEvent - - - -> EventsV1Event createNamespacedEvent(body) - -create an Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiCreateNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiCreateNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - deprecatedCount: 1, - deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedSource: { - component: "component_example", - host: "host_example", - }, - eventTime: "eventTime_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - note: "note_example", - reason: "reason_example", - regarding: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingController: "reportingController_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **EventsV1Event**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -EventsV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedEvent - - - -> V1Status deleteCollectionNamespacedEvent() - -delete collection of Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiDeleteCollectionNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiDeleteCollectionNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedEvent - - - -> V1Status deleteNamespacedEvent() - -delete an Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiDeleteNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiDeleteNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listEventForAllNamespaces - - - -> EventsV1EventList listEventForAllNamespaces() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiListEventForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiListEventForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEventForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -EventsV1EventList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedEvent - - - -> EventsV1EventList listNamespacedEvent() - -list or watch objects of kind Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiListNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiListNamespacedEventRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -EventsV1EventList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedEvent - - - -> EventsV1Event patchNamespacedEvent(body) - -partially update the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiPatchNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiPatchNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -EventsV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedEvent - - - -> EventsV1Event readNamespacedEvent() - -read the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiReadNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiReadNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -EventsV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedEvent - - - -> EventsV1Event replaceNamespacedEvent(body) - -replace the specified Event - -### Example - - -```typescript -import { createConfiguration, EventsV1Api } from '@kubernetes/client-node'; -import type { EventsV1ApiReplaceNamespacedEventRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new EventsV1Api(configuration); - -const request: EventsV1ApiReplaceNamespacedEventRequest = { - // name of the Event - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - action: "action_example", - apiVersion: "apiVersion_example", - deprecatedCount: 1, - deprecatedFirstTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedLastTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deprecatedSource: { - component: "component_example", - host: "host_example", - }, - eventTime: "eventTime_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - note: "note_example", - reason: "reason_example", - regarding: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - related: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - reportingController: "reportingController_example", - reportingInstance: "reportingInstance_example", - series: { - count: 1, - lastObservedTime: "lastObservedTime_example", - }, - type: "type_example", - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEvent(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **EventsV1Event**| | - **name** | [**string**] | name of the Event | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -EventsV1Event - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeApi.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeApi.md deleted file mode 100644 index 975a97e8ac4..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: NodeApi -title: NodeApi -sidebar_label: NodeApi -sidebar_position: 5 ---- -# NodeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/core-resources/NodeApi#getAPIGroup) | **GET** /apis/node.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, NodeApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeV1Api.md deleted file mode 100644 index 95f49bda4a8..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/core-resources/NodeV1Api.md +++ /dev/null @@ -1,751 +0,0 @@ ---- -id: NodeV1Api -title: NodeV1Api -sidebar_label: NodeV1Api -sidebar_position: 6 ---- -# NodeV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#createRuntimeClass) | **POST** /apis/node.k8s.io/v1/runtimeclasses | -[**deleteCollectionRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#deleteCollectionRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses | -[**deleteRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#deleteRuntimeClass) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**getAPIResources**](/docs/api-reference/core-resources/NodeV1Api#getAPIResources) | **GET** /apis/node.k8s.io/v1/ | -[**listRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#listRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses | -[**patchRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#patchRuntimeClass) | **PATCH** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**readRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#readRuntimeClass) | **GET** /apis/node.k8s.io/v1/runtimeclasses/{name} | -[**replaceRuntimeClass**](/docs/api-reference/core-resources/NodeV1Api#replaceRuntimeClass) | **PUT** /apis/node.k8s.io/v1/runtimeclasses/{name} | - -### createRuntimeClass - - - -> V1RuntimeClass createRuntimeClass(body) - -create a RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiCreateRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiCreateRuntimeClassRequest = { - - body: { - apiVersion: "apiVersion_example", - handler: "handler_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - overhead: { - podFixed: { - "key": "key_example", - }, - }, - scheduling: { - nodeSelector: { - "key": "key_example", - }, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RuntimeClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1RuntimeClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionRuntimeClass - - - -> V1Status deleteCollectionRuntimeClass() - -delete collection of RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiDeleteCollectionRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiDeleteCollectionRuntimeClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteRuntimeClass - - - -> V1Status deleteRuntimeClass() - -delete a RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiDeleteRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiDeleteRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listRuntimeClass - - - -> V1RuntimeClassList listRuntimeClass() - -list or watch objects of kind RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiListRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiListRuntimeClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RuntimeClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchRuntimeClass - - - -> V1RuntimeClass patchRuntimeClass(body) - -partially update the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiPatchRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiPatchRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1RuntimeClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readRuntimeClass - - - -> V1RuntimeClass readRuntimeClass() - -read the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiReadRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiReadRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1RuntimeClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceRuntimeClass - - - -> V1RuntimeClass replaceRuntimeClass(body) - -replace the specified RuntimeClass - -### Example - - -```typescript -import { createConfiguration, NodeV1Api } from '@kubernetes/client-node'; -import type { NodeV1ApiReplaceRuntimeClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NodeV1Api(configuration); - -const request: NodeV1ApiReplaceRuntimeClassRequest = { - // name of the RuntimeClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - handler: "handler_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - overhead: { - podFixed: { - "key": "key_example", - }, - }, - scheduling: { - nodeSelector: { - "key": "key_example", - }, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceRuntimeClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RuntimeClass**| | - **name** | [**string**] | name of the RuntimeClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1RuntimeClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/core-resources/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/core-resources/_category_.json deleted file mode 100644 index b8f850a4d43..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/core-resources/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Core Resources", - "position": 1 -} diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryApi.md b/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryApi.md deleted file mode 100644 index ba4ca020e47..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: DiscoveryApi -title: DiscoveryApi -sidebar_label: DiscoveryApi -sidebar_position: 1 ---- -# DiscoveryApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/networking/DiscoveryApi#getAPIGroup) | **GET** /apis/discovery.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, DiscoveryApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryV1Api.md deleted file mode 100644 index d9fcde9ab2f..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/networking/DiscoveryV1Api.md +++ /dev/null @@ -1,913 +0,0 @@ ---- -id: DiscoveryV1Api -title: DiscoveryV1Api -sidebar_label: DiscoveryV1Api -sidebar_position: 2 ---- -# DiscoveryV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#createNamespacedEndpointSlice) | **POST** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**deleteCollectionNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#deleteCollectionNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**deleteNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#deleteNamespacedEndpointSlice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**getAPIResources**](/docs/api-reference/networking/DiscoveryV1Api#getAPIResources) | **GET** /apis/discovery.k8s.io/v1/ | -[**listEndpointSliceForAllNamespaces**](/docs/api-reference/networking/DiscoveryV1Api#listEndpointSliceForAllNamespaces) | **GET** /apis/discovery.k8s.io/v1/endpointslices | -[**listNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#listNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices | -[**patchNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#patchNamespacedEndpointSlice) | **PATCH** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**readNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#readNamespacedEndpointSlice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | -[**replaceNamespacedEndpointSlice**](/docs/api-reference/networking/DiscoveryV1Api#replaceNamespacedEndpointSlice) | **PUT** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} | - -### createNamespacedEndpointSlice - - - -> V1EndpointSlice createNamespacedEndpointSlice(body) - -create an EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiCreateNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiCreateNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - addressType: "addressType_example", - apiVersion: "apiVersion_example", - endpoints: [ - { - addresses: [ - "addresses_example", - ], - conditions: { - ready: true, - serving: true, - terminating: true, - }, - deprecatedTopology: { - "key": "key_example", - }, - hints: { - forNodes: [ - { - name: "name_example", - }, - ], - forZones: [ - { - name: "name_example", - }, - ], - }, - hostname: "hostname_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - zone: "zone_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1EndpointSlice**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1EndpointSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedEndpointSlice - - - -> V1Status deleteCollectionNamespacedEndpointSlice() - -delete collection of EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiDeleteCollectionNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedEndpointSlice - - - -> V1Status deleteNamespacedEndpointSlice() - -delete an EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiDeleteNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listEndpointSliceForAllNamespaces - - - -> V1EndpointSliceList listEndpointSliceForAllNamespaces() - -list or watch objects of kind EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiListEndpointSliceForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listEndpointSliceForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1EndpointSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedEndpointSlice - - - -> V1EndpointSliceList listNamespacedEndpointSlice() - -list or watch objects of kind EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiListNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiListNamespacedEndpointSliceRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1EndpointSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedEndpointSlice - - - -> V1EndpointSlice patchNamespacedEndpointSlice(body) - -partially update the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiPatchNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiPatchNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1EndpointSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedEndpointSlice - - - -> V1EndpointSlice readNamespacedEndpointSlice() - -read the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiReadNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiReadNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1EndpointSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedEndpointSlice - - - -> V1EndpointSlice replaceNamespacedEndpointSlice(body) - -replace the specified EndpointSlice - -### Example - - -```typescript -import { createConfiguration, DiscoveryV1Api } from '@kubernetes/client-node'; -import type { DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new DiscoveryV1Api(configuration); - -const request: DiscoveryV1ApiReplaceNamespacedEndpointSliceRequest = { - // name of the EndpointSlice - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - addressType: "addressType_example", - apiVersion: "apiVersion_example", - endpoints: [ - { - addresses: [ - "addresses_example", - ], - conditions: { - ready: true, - serving: true, - terminating: true, - }, - deprecatedTopology: { - "key": "key_example", - }, - hints: { - forNodes: [ - { - name: "name_example", - }, - ], - forZones: [ - { - name: "name_example", - }, - ], - }, - hostname: "hostname_example", - nodeName: "nodeName_example", - targetRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - zone: "zone_example", - }, - ], - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - ports: [ - { - appProtocol: "appProtocol_example", - name: "name_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedEndpointSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1EndpointSlice**| | - **name** | [**string**] | name of the EndpointSlice | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1EndpointSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingApi.md b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingApi.md deleted file mode 100644 index 47fb65146fa..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: NetworkingApi -title: NetworkingApi -sidebar_label: NetworkingApi -sidebar_position: 3 ---- -# NetworkingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/networking/NetworkingApi#getAPIGroup) | **GET** /apis/networking.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, NetworkingApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1Api.md deleted file mode 100644 index b49013d79f0..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1Api.md +++ /dev/null @@ -1,4552 +0,0 @@ ---- -id: NetworkingV1Api -title: NetworkingV1Api -sidebar_label: NetworkingV1Api -sidebar_position: 4 ---- -# NetworkingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createIPAddress**](/docs/api-reference/networking/NetworkingV1Api#createIPAddress) | **POST** /apis/networking.k8s.io/v1/ipaddresses | -[**createIngressClass**](/docs/api-reference/networking/NetworkingV1Api#createIngressClass) | **POST** /apis/networking.k8s.io/v1/ingressclasses | -[**createNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#createNamespacedIngress) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**createNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#createNamespacedNetworkPolicy) | **POST** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**createServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1/servicecidrs | -[**deleteCollectionIPAddress**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses | -[**deleteCollectionIngressClass**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses | -[**deleteCollectionNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**deleteCollectionNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**deleteCollectionServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs | -[**deleteIPAddress**](/docs/api-reference/networking/NetworkingV1Api#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**deleteIngressClass**](/docs/api-reference/networking/NetworkingV1Api#deleteIngressClass) | **DELETE** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**deleteNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#deleteNamespacedIngress) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**deleteNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#deleteNamespacedNetworkPolicy) | **DELETE** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**deleteServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**getAPIResources**](/docs/api-reference/networking/NetworkingV1Api#getAPIResources) | **GET** /apis/networking.k8s.io/v1/ | -[**listIPAddress**](/docs/api-reference/networking/NetworkingV1Api#listIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses | -[**listIngressClass**](/docs/api-reference/networking/NetworkingV1Api#listIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses | -[**listIngressForAllNamespaces**](/docs/api-reference/networking/NetworkingV1Api#listIngressForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/ingresses | -[**listNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#listNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses | -[**listNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#listNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies | -[**listNetworkPolicyForAllNamespaces**](/docs/api-reference/networking/NetworkingV1Api#listNetworkPolicyForAllNamespaces) | **GET** /apis/networking.k8s.io/v1/networkpolicies | -[**listServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs | -[**patchIPAddress**](/docs/api-reference/networking/NetworkingV1Api#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**patchIngressClass**](/docs/api-reference/networking/NetworkingV1Api#patchIngressClass) | **PATCH** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**patchNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedIngress) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**patchNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedIngressStatus) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**patchNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#patchNamespacedNetworkPolicy) | **PATCH** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**patchServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**patchServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | -[**readIPAddress**](/docs/api-reference/networking/NetworkingV1Api#readIPAddress) | **GET** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**readIngressClass**](/docs/api-reference/networking/NetworkingV1Api#readIngressClass) | **GET** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**readNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedIngress) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**readNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedIngressStatus) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**readNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#readNamespacedNetworkPolicy) | **GET** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**readServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**readServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | -[**replaceIPAddress**](/docs/api-reference/networking/NetworkingV1Api#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1/ipaddresses/{name} | -[**replaceIngressClass**](/docs/api-reference/networking/NetworkingV1Api#replaceIngressClass) | **PUT** /apis/networking.k8s.io/v1/ingressclasses/{name} | -[**replaceNamespacedIngress**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedIngress) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} | -[**replaceNamespacedIngressStatus**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedIngressStatus) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status | -[**replaceNamespacedNetworkPolicy**](/docs/api-reference/networking/NetworkingV1Api#replaceNamespacedNetworkPolicy) | **PUT** /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} | -[**replaceServiceCIDR**](/docs/api-reference/networking/NetworkingV1Api#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name} | -[**replaceServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1Api#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1/servicecidrs/{name}/status | - -### createIPAddress - - - -> V1IPAddress createIPAddress(body) - -create an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateIPAddressRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IPAddress**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createIngressClass - - - -> V1IngressClass createIngressClass(body) - -create an IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateIngressClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controller: "controller_example", - parameters: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - scope: "scope_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IngressClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1IngressClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedIngress - - - -> V1Ingress createNamespacedIngress(body) - -create an Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedNetworkPolicy - - - -> V1NetworkPolicy createNamespacedNetworkPolicy(body) - -create a NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - egress: [ - { - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - to: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - }, - ], - ingress: [ - { - _from: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - }, - ], - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - policyTypes: [ - "policyTypes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1NetworkPolicy**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createServiceCIDR - - - -> V1ServiceCIDR createServiceCIDR(body) - -create a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiCreateServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiCreateServiceCIDRRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionIPAddress - - - -> V1Status deleteCollectionIPAddress() - -delete collection of IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionIngressClass - - - -> V1Status deleteCollectionIngressClass() - -delete collection of IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionIngressClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedIngress - - - -> V1Status deleteCollectionNamespacedIngress() - -delete collection of Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedNetworkPolicy - - - -> V1Status deleteCollectionNamespacedNetworkPolicy() - -delete collection of NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionServiceCIDR - - - -> V1Status deleteCollectionServiceCIDR() - -delete collection of ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteCollectionServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteCollectionServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteIPAddress - - - -> V1Status deleteIPAddress() - -delete an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteIngressClass - - - -> V1Status deleteIngressClass() - -delete an IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteIngressClassRequest = { - // name of the IngressClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedIngress - - - -> V1Status deleteNamespacedIngress() - -delete an Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedNetworkPolicy - - - -> V1Status deleteNamespacedNetworkPolicy() - -delete a NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteServiceCIDR - - - -> V1Status deleteServiceCIDR() - -delete a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiDeleteServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiDeleteServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listIPAddress - - - -> V1IPAddressList listIPAddress() - -list or watch objects of kind IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1IPAddressList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listIngressClass - - - -> V1IngressClassList listIngressClass() - -list or watch objects of kind IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIngressClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1IngressClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listIngressForAllNamespaces - - - -> V1IngressList listIngressForAllNamespaces() - -list or watch objects of kind Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListIngressForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListIngressForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIngressForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1IngressList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedIngress - - - -> V1IngressList listNamespacedIngress() - -list or watch objects of kind Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNamespacedIngressRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1IngressList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedNetworkPolicy - - - -> V1NetworkPolicyList listNamespacedNetworkPolicy() - -list or watch objects of kind NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNamespacedNetworkPolicyRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNetworkPolicyForAllNamespaces - - - -> V1NetworkPolicyList listNetworkPolicyForAllNamespaces() - -list or watch objects of kind NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListNetworkPolicyForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNetworkPolicyForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicyList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listServiceCIDR - - - -> V1ServiceCIDRList listServiceCIDR() - -list or watch objects of kind ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiListServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiListServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDRList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchIPAddress - - - -> V1IPAddress patchIPAddress(body) - -partially update the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchIngressClass - - - -> V1IngressClass patchIngressClass(body) - -partially update the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchIngressClassRequest = { - // name of the IngressClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1IngressClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedIngress - - - -> V1Ingress patchNamespacedIngress(body) - -partially update the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedIngressStatus - - - -> V1Ingress patchNamespacedIngressStatus(body) - -partially update status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchNamespacedIngressStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedNetworkPolicy - - - -> V1NetworkPolicy patchNamespacedNetworkPolicy(body) - -partially update the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchServiceCIDR - - - -> V1ServiceCIDR patchServiceCIDR(body) - -partially update the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchServiceCIDRStatus - - - -> V1ServiceCIDR patchServiceCIDRStatus(body) - -partially update status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiPatchServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiPatchServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readIPAddress - - - -> V1IPAddress readIPAddress() - -read the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readIngressClass - - - -> V1IngressClass readIngressClass() - -read the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadIngressClassRequest = { - // name of the IngressClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1IngressClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedIngress - - - -> V1Ingress readNamespacedIngress() - -read the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedIngressStatus - - - -> V1Ingress readNamespacedIngressStatus() - -read status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadNamespacedIngressStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedNetworkPolicy - - - -> V1NetworkPolicy readNamespacedNetworkPolicy() - -read the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1NetworkPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readServiceCIDR - - - -> V1ServiceCIDR readServiceCIDR() - -read the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readServiceCIDRStatus - - - -> V1ServiceCIDR readServiceCIDRStatus() - -read status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReadServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReadServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceIPAddress - - - -> V1IPAddress replaceIPAddress(body) - -replace the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IPAddress**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceIngressClass - - - -> V1IngressClass replaceIngressClass(body) - -replace the specified IngressClass - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceIngressClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceIngressClassRequest = { - // name of the IngressClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - controller: "controller_example", - parameters: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - scope: "scope_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIngressClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1IngressClass**| | - **name** | [**string**] | name of the IngressClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1IngressClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedIngress - - - -> V1Ingress replaceNamespacedIngress(body) - -replace the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceNamespacedIngressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedIngressRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedIngress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedIngressStatus - - - -> V1Ingress replaceNamespacedIngressStatus(body) - -replace status of the specified Ingress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceNamespacedIngressStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedIngressStatusRequest = { - // name of the Ingress - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - defaultBackend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - ingressClassName: "ingressClassName_example", - rules: [ - { - host: "host_example", - http: { - paths: [ - { - backend: { - resource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - service: { - name: "name_example", - port: { - name: "name_example", - number: 1, - }, - }, - }, - path: "path_example", - pathType: "pathType_example", - }, - ], - }, - }, - ], - tls: [ - { - hosts: [ - "hosts_example", - ], - secretName: "secretName_example", - }, - ], - }, - status: { - loadBalancer: { - ingress: [ - { - hostname: "hostname_example", - ip: "ip_example", - ports: [ - { - error: "error_example", - port: 1, - protocol: "protocol_example", - }, - ], - }, - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedIngressStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Ingress**| | - **name** | [**string**] | name of the Ingress | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Ingress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedNetworkPolicy - - - -> V1NetworkPolicy replaceNamespacedNetworkPolicy(body) - -replace the specified NetworkPolicy - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceNamespacedNetworkPolicyRequest = { - // name of the NetworkPolicy - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - egress: [ - { - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - to: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - }, - ], - ingress: [ - { - _from: [ - { - ipBlock: { - cidr: "cidr_example", - except: [ - "except_example", - ], - }, - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - ], - ports: [ - { - endPort: 1, - port: "port_example", - protocol: "protocol_example", - }, - ], - }, - ], - podSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - policyTypes: [ - "policyTypes_example", - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedNetworkPolicy(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1NetworkPolicy**| | - **name** | [**string**] | name of the NetworkPolicy | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1NetworkPolicy - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceServiceCIDR - - - -> V1ServiceCIDR replaceServiceCIDR(body) - -replace the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceServiceCIDRStatus - - - -> V1ServiceCIDR replaceServiceCIDRStatus(body) - -replace status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1Api } from '@kubernetes/client-node'; -import type { NetworkingV1ApiReplaceServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1Api(configuration); - -const request: NetworkingV1ApiReplaceServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1beta1Api.md deleted file mode 100644 index f14ea0a610c..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/networking/NetworkingV1beta1Api.md +++ /dev/null @@ -1,1675 +0,0 @@ ---- -id: NetworkingV1beta1Api -title: NetworkingV1beta1Api -sidebar_label: NetworkingV1beta1Api -sidebar_position: 5 ---- -# NetworkingV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#createIPAddress) | **POST** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**createServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#createServiceCIDR) | **POST** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**deleteCollectionIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteCollectionIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**deleteCollectionServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteCollectionServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**deleteIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteIPAddress) | **DELETE** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**deleteServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#deleteServiceCIDR) | **DELETE** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**getAPIResources**](/docs/api-reference/networking/NetworkingV1beta1Api#getAPIResources) | **GET** /apis/networking.k8s.io/v1beta1/ | -[**listIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#listIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses | -[**listServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#listServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs | -[**patchIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#patchIPAddress) | **PATCH** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**patchServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#patchServiceCIDR) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**patchServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#patchServiceCIDRStatus) | **PATCH** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | -[**readIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#readIPAddress) | **GET** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**readServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#readServiceCIDR) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**readServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#readServiceCIDRStatus) | **GET** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | -[**replaceIPAddress**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceIPAddress) | **PUT** /apis/networking.k8s.io/v1beta1/ipaddresses/{name} | -[**replaceServiceCIDR**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceServiceCIDR) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name} | -[**replaceServiceCIDRStatus**](/docs/api-reference/networking/NetworkingV1beta1Api#replaceServiceCIDRStatus) | **PUT** /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status | - -### createIPAddress - - - -> V1beta1IPAddress createIPAddress(body) - -create an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiCreateIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiCreateIPAddressRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1IPAddress**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createServiceCIDR - - - -> V1beta1ServiceCIDR createServiceCIDR(body) - -create a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiCreateServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiCreateServiceCIDRRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionIPAddress - - - -> V1Status deleteCollectionIPAddress() - -delete collection of IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiDeleteCollectionIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteCollectionIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionServiceCIDR - - - -> V1Status deleteCollectionServiceCIDR() - -delete collection of ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteCollectionServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteIPAddress - - - -> V1Status deleteIPAddress() - -delete an IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiDeleteIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteServiceCIDR - - - -> V1Status deleteServiceCIDR() - -delete a ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiDeleteServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiDeleteServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listIPAddress - - - -> V1beta1IPAddressList listIPAddress() - -list or watch objects of kind IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiListIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiListIPAddressRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1IPAddressList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listServiceCIDR - - - -> V1beta1ServiceCIDRList listServiceCIDR() - -list or watch objects of kind ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiListServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiListServiceCIDRRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDRList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchIPAddress - - - -> V1beta1IPAddress patchIPAddress(body) - -partially update the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiPatchIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchServiceCIDR - - - -> V1beta1ServiceCIDR patchServiceCIDR(body) - -partially update the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiPatchServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchServiceCIDRStatus - - - -> V1beta1ServiceCIDR patchServiceCIDRStatus(body) - -partially update status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiPatchServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiPatchServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readIPAddress - - - -> V1beta1IPAddress readIPAddress() - -read the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReadIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadIPAddressRequest = { - // name of the IPAddress - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readServiceCIDR - - - -> V1beta1ServiceCIDR readServiceCIDR() - -read the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReadServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readServiceCIDRStatus - - - -> V1beta1ServiceCIDR readServiceCIDRStatus() - -read status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReadServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReadServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceIPAddress - - - -> V1beta1IPAddress replaceIPAddress(body) - -replace the specified IPAddress - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReplaceIPAddressRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceIPAddressRequest = { - // name of the IPAddress - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - parentRef: { - group: "group_example", - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceIPAddress(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1IPAddress**| | - **name** | [**string**] | name of the IPAddress | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1IPAddress - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceServiceCIDR - - - -> V1beta1ServiceCIDR replaceServiceCIDR(body) - -replace the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReplaceServiceCIDRRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceServiceCIDRRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDR(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceServiceCIDRStatus - - - -> V1beta1ServiceCIDR replaceServiceCIDRStatus(body) - -replace status of the specified ServiceCIDR - -### Example - - -```typescript -import { createConfiguration, NetworkingV1beta1Api } from '@kubernetes/client-node'; -import type { NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new NetworkingV1beta1Api(configuration); - -const request: NetworkingV1beta1ApiReplaceServiceCIDRStatusRequest = { - // name of the ServiceCIDR - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - cidrs: [ - "cidrs_example", - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceServiceCIDRStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ServiceCIDR**| | - **name** | [**string**] | name of the ServiceCIDR | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ServiceCIDR - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/networking/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/networking/_category_.json deleted file mode 100644 index c1c4f2787e3..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/networking/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Networking", - "position": 3 -} diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ApisApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/ApisApi.md deleted file mode 100644 index 966043d77e2..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/ApisApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: ApisApi -title: ApisApi -sidebar_label: ApisApi -sidebar_position: 1 ---- -# ApisApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIVersions**](/docs/api-reference/other/ApisApi#getAPIVersions) | **GET** /apis/ | - -### getAPIVersions - - - -> V1APIGroupList getAPIVersions() - -get available API versions - -### Example - - -```typescript -import { createConfiguration, ApisApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ApisApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIVersions(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroupList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingApi.md deleted file mode 100644 index 55b0e1d62ba..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AutoscalingApi -title: AutoscalingApi -sidebar_label: AutoscalingApi -sidebar_position: 2 ---- -# AutoscalingApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/other/AutoscalingApi#getAPIGroup) | **GET** /apis/autoscaling/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AutoscalingApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV1Api.md deleted file mode 100644 index 0b0e3e3b682..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV1Api.md +++ /dev/null @@ -1,1125 +0,0 @@ ---- -id: AutoscalingV1Api -title: AutoscalingV1Api -sidebar_label: AutoscalingV1Api -sidebar_position: 3 ---- -# AutoscalingV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteCollectionNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**getAPIResources**](/docs/api-reference/other/AutoscalingV1Api#getAPIResources) | **GET** /apis/autoscaling/v1/ | -[**listHorizontalPodAutoscalerForAllNamespaces**](/docs/api-reference/other/AutoscalingV1Api#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v1/horizontalpodautoscalers | -[**listNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers | -[**patchNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**patchNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**readNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**readNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**replaceNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV1Api#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**replaceNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV1Api#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | - -### createNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) - -create a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiCreateNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedHorizontalPodAutoscaler - - - -> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() - -delete collection of HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedHorizontalPodAutoscaler - - - -> V1Status deleteNamespacedHorizontalPodAutoscaler() - -delete a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listHorizontalPodAutoscalerForAllNamespaces - - - -> V1HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscalerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiListNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscalerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) - -partially update the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedHorizontalPodAutoscalerStatus - - - -> V1HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) - -partially update status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() - -read the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedHorizontalPodAutoscalerStatus - - - -> V1HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() - -read status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedHorizontalPodAutoscaler - - - -> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) - -replace the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedHorizontalPodAutoscalerStatus - - - -> V1HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) - -replace status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV1Api } from '@kubernetes/client-node'; -import type { AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV1Api(configuration); - -const request: AutoscalingV1ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxReplicas: 1, - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - targetCPUUtilizationPercentage: 1, - }, - status: { - currentCPUUtilizationPercentage: 1, - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV2Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV2Api.md deleted file mode 100644 index 95197559ac4..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/AutoscalingV2Api.md +++ /dev/null @@ -1,1833 +0,0 @@ ---- -id: AutoscalingV2Api -title: AutoscalingV2Api -sidebar_label: AutoscalingV2Api -sidebar_position: 4 ---- -# AutoscalingV2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#createNamespacedHorizontalPodAutoscaler) | **POST** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteCollectionNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#deleteCollectionNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**deleteNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#deleteNamespacedHorizontalPodAutoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**getAPIResources**](/docs/api-reference/other/AutoscalingV2Api#getAPIResources) | **GET** /apis/autoscaling/v2/ | -[**listHorizontalPodAutoscalerForAllNamespaces**](/docs/api-reference/other/AutoscalingV2Api#listHorizontalPodAutoscalerForAllNamespaces) | **GET** /apis/autoscaling/v2/horizontalpodautoscalers | -[**listNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#listNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers | -[**patchNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#patchNamespacedHorizontalPodAutoscaler) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**patchNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#patchNamespacedHorizontalPodAutoscalerStatus) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**readNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#readNamespacedHorizontalPodAutoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**readNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#readNamespacedHorizontalPodAutoscalerStatus) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | -[**replaceNamespacedHorizontalPodAutoscaler**](/docs/api-reference/other/AutoscalingV2Api#replaceNamespacedHorizontalPodAutoscaler) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} | -[**replaceNamespacedHorizontalPodAutoscalerStatus**](/docs/api-reference/other/AutoscalingV2Api#replaceNamespacedHorizontalPodAutoscalerStatus) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status | - -### createNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscaler createNamespacedHorizontalPodAutoscaler(body) - -create a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiCreateNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedHorizontalPodAutoscaler - - - -> V1Status deleteCollectionNamespacedHorizontalPodAutoscaler() - -delete collection of HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiDeleteCollectionNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedHorizontalPodAutoscaler - - - -> V1Status deleteNamespacedHorizontalPodAutoscaler() - -delete a HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiDeleteNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listHorizontalPodAutoscalerForAllNamespaces - - - -> V2HorizontalPodAutoscalerList listHorizontalPodAutoscalerForAllNamespaces() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiListHorizontalPodAutoscalerForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listHorizontalPodAutoscalerForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscalerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscalerList listNamespacedHorizontalPodAutoscaler() - -list or watch objects of kind HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiListNamespacedHorizontalPodAutoscalerRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscalerList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscaler(body) - -partially update the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedHorizontalPodAutoscalerStatus - - - -> V2HorizontalPodAutoscaler patchNamespacedHorizontalPodAutoscalerStatus(body) - -partially update status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiPatchNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscaler() - -read the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedHorizontalPodAutoscalerStatus - - - -> V2HorizontalPodAutoscaler readNamespacedHorizontalPodAutoscalerStatus() - -read status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReadNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedHorizontalPodAutoscaler - - - -> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscaler(body) - -replace the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscaler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedHorizontalPodAutoscalerStatus - - - -> V2HorizontalPodAutoscaler replaceNamespacedHorizontalPodAutoscalerStatus(body) - -replace status of the specified HorizontalPodAutoscaler - -### Example - - -```typescript -import { createConfiguration, AutoscalingV2Api } from '@kubernetes/client-node'; -import type { AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AutoscalingV2Api(configuration); - -const request: AutoscalingV2ApiReplaceNamespacedHorizontalPodAutoscalerStatusRequest = { - // name of the HorizontalPodAutoscaler - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - behavior: { - scaleDown: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - scaleUp: { - policies: [ - { - periodSeconds: 1, - type: "type_example", - value: 1, - }, - ], - selectPolicy: "selectPolicy_example", - stabilizationWindowSeconds: 1, - tolerance: "tolerance_example", - }, - }, - maxReplicas: 1, - metrics: [ - { - containerResource: { - container: "container_example", - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - external: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - object: { - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - pods: { - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - resource: { - name: "name_example", - target: { - averageUtilization: 1, - averageValue: "averageValue_example", - type: "type_example", - value: "value_example", - }, - }, - type: "type_example", - }, - ], - minReplicas: 1, - scaleTargetRef: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentMetrics: [ - { - containerResource: { - container: "container_example", - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - external: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - object: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - describedObject: { - apiVersion: "apiVersion_example", - kind: "kind_example", - name: "name_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - pods: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - metric: { - name: "name_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - }, - }, - resource: { - current: { - averageUtilization: 1, - averageValue: "averageValue_example", - value: "value_example", - }, - name: "name_example", - }, - type: "type_example", - }, - ], - currentReplicas: 1, - desiredReplicas: 1, - lastScaleTime: new Date('1970-01-01T00:00:00.00Z'), - observedGeneration: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedHorizontalPodAutoscalerStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V2HorizontalPodAutoscaler**| | - **name** | [**string**] | name of the HorizontalPodAutoscaler | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V2HorizontalPodAutoscaler - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/CustomObjectsApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/CustomObjectsApi.md deleted file mode 100644 index 7b1af985aa2..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/CustomObjectsApi.md +++ /dev/null @@ -1,2234 +0,0 @@ ---- -id: CustomObjectsApi -title: CustomObjectsApi -sidebar_label: CustomObjectsApi -sidebar_position: 5 ---- -# CustomObjectsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#createClusterCustomObject) | **POST** /apis/{group}/{version}/{plural} | -[**createNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#createNamespacedCustomObject) | **POST** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**deleteClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural}/{name} | -[**deleteCollectionClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteCollectionClusterCustomObject) | **DELETE** /apis/{group}/{version}/{plural} | -[**deleteCollectionNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteCollectionNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**deleteNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#deleteNamespacedCustomObject) | **DELETE** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**getAPIResources**](/docs/api-reference/other/CustomObjectsApi#getAPIResources) | **GET** /apis/{group}/{version} | -[**getClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObject) | **GET** /apis/{group}/{version}/{plural}/{name} | -[**getClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObjectScale) | **GET** /apis/{group}/{version}/{plural}/{name}/scale | -[**getClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#getClusterCustomObjectStatus) | **GET** /apis/{group}/{version}/{plural}/{name}/status | -[**getNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**getNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObjectScale) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**getNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#getNamespacedCustomObjectStatus) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | -[**listClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#listClusterCustomObject) | **GET** /apis/{group}/{version}/{plural} | -[**listCustomObjectForAllNamespaces**](/docs/api-reference/other/CustomObjectsApi#listCustomObjectForAllNamespaces) | **GET** /apis/{group}/{version}/{resource_plural} | -[**listNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#listNamespacedCustomObject) | **GET** /apis/{group}/{version}/namespaces/{namespace}/{plural} | -[**patchClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObject) | **PATCH** /apis/{group}/{version}/{plural}/{name} | -[**patchClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObjectScale) | **PATCH** /apis/{group}/{version}/{plural}/{name}/scale | -[**patchClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#patchClusterCustomObjectStatus) | **PATCH** /apis/{group}/{version}/{plural}/{name}/status | -[**patchNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObject) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**patchNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObjectScale) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**patchNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#patchNamespacedCustomObjectStatus) | **PATCH** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | -[**replaceClusterCustomObject**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObject) | **PUT** /apis/{group}/{version}/{plural}/{name} | -[**replaceClusterCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObjectScale) | **PUT** /apis/{group}/{version}/{plural}/{name}/scale | -[**replaceClusterCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#replaceClusterCustomObjectStatus) | **PUT** /apis/{group}/{version}/{plural}/{name}/status | -[**replaceNamespacedCustomObject**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObject) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | -[**replaceNamespacedCustomObjectScale**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObjectScale) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | -[**replaceNamespacedCustomObjectStatus**](/docs/api-reference/other/CustomObjectsApi#replaceNamespacedCustomObjectStatus) | **PUT** /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | - -### createClusterCustomObject - - - -> any createClusterCustomObject(body) - -Creates a cluster scoped Custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiCreateClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiCreateClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // The JSON schema of the Resource to create. - body: {}, - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to create. | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Created | - | -**401** | Unauthorized | - | - -### createNamespacedCustomObject - - - -> any createNamespacedCustomObject(body) - -Creates a namespace scoped Custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiCreateNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiCreateNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // The JSON schema of the Resource to create. - body: {}, - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to create. | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Created | - | -**401** | Unauthorized | - | - -### deleteClusterCustomObject - - - -> any deleteClusterCustomObject() - -Deletes the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiDeleteClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterCustomObject - - - -> any deleteCollectionClusterCustomObject() - -Delete collection of cluster scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiDeleteCollectionClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteCollectionClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedCustomObject - - - -> any deleteCollectionNamespacedCustomObject() - -Delete collection of namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedCustomObject - - - -> any deleteNamespacedCustomObject() - -Deletes the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiDeleteNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiDeleteNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional) - propagationPolicy: "propagationPolicy_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetAPIResourcesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetAPIResourcesRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", -}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getClusterCustomObject - - - -> any getClusterCustomObject() - -Returns a cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A single Resource | - | -**401** | Unauthorized | - | - -### getClusterCustomObjectScale - - - -> any getClusterCustomObjectScale() - -read scale of the specified custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getClusterCustomObjectStatus - - - -> any getClusterCustomObjectStatus() - -read status of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getNamespacedCustomObject - - - -> any getNamespacedCustomObject() - -Returns a namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A single Resource | - | -**401** | Unauthorized | - | - -### getNamespacedCustomObjectScale - - - -> any getNamespacedCustomObjectScale() - -read scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getNamespacedCustomObjectStatus - - - -> any getNamespacedCustomObjectStatus() - -read status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiGetNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiGetNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", -}; - -const data = await apiInstance.getNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterCustomObject - - - -> any listClusterCustomObject() - -list or watch cluster scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiListClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListClusterCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCustomObjectForAllNamespaces - - - -> any listCustomObjectForAllNamespaces() - -list or watch namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiListCustomObjectForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListCustomObjectForAllNamespacesRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - resourcePlural: "resource_plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listCustomObjectForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **resourcePlural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedCustomObject - - - -> any listNamespacedCustomObject() - -list or watch namespace scoped custom objects - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiListNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiListNamespacedCustomObjectRequest = { - // The custom resource\'s group name - group: "group_example", - // The custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // The custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // If \'true\', then the output is pretty printed. (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **group** | [**string**] | The custom resource\'s group name | defaults to undefined - **version** | [**string**] | The custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | The custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it\'s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/json;stream=watch - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterCustomObject - - - -> any patchClusterCustomObject(body) - -patch the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to patch. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to patch. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterCustomObjectScale - - - -> any patchClusterCustomObjectScale(body) - -partially update scale of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterCustomObjectStatus - - - -> any patchClusterCustomObjectStatus(body) - -partially update status of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedCustomObject - - - -> any patchNamespacedCustomObject(body) - -patch the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to patch. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to patch. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedCustomObjectScale - - - -> any patchNamespacedCustomObjectScale(body) - -partially update scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedCustomObjectStatus - - - -> any patchNamespacedCustomObjectStatus(body) - -partially update status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiPatchNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiPatchNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterCustomObject - - - -> any replaceClusterCustomObject(body) - -replace the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceClusterCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom object\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to replace. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to replace. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom object\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterCustomObjectScale - - - -> any replaceClusterCustomObjectScale(body) - -replace scale of the specified cluster scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceClusterCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceClusterCustomObjectStatus - - - -> any replaceClusterCustomObjectStatus(body) - -replace status of the cluster scoped specified custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceClusterCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceClusterCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedCustomObject - - - -> any replaceNamespacedCustomObject(body) - -replace the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceNamespacedCustomObjectRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - // The JSON schema of the Resource to replace. - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObject(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| The JSON schema of the Resource to replace. | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedCustomObjectScale - - - -> any replaceNamespacedCustomObjectScale(body) - -replace scale of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObjectScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedCustomObjectStatus - - - -> any replaceNamespacedCustomObjectStatus(body) - -replace status of the specified namespace scoped custom object - -### Example - - -```typescript -import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node'; -import type { CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CustomObjectsApi(configuration); - -const request: CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest = { - // the custom resource\'s group - group: "group_example", - // the custom resource\'s version - version: "version_example", - // The custom resource\'s namespace - namespace: "namespace_example", - // the custom resource\'s plural name. For TPRs this would be lowercase plural kind. - plural: "plural_example", - // the custom object\'s name - name: "name_example", - - body: {}, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCustomObjectStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **group** | [**string**] | the custom resource\'s group | defaults to undefined - **version** | [**string**] | the custom resource\'s version | defaults to undefined - **namespace** | [**string**] | The custom resource\'s namespace | defaults to undefined - **plural** | [**string**] | the custom resource\'s plural name. For TPRs this would be lowercase plural kind. | defaults to undefined - **name** | [**string**] | the custom object\'s name | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) | (optional) defaults to undefined - -### Return type - -any - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverApi.md deleted file mode 100644 index 41a4b06ea22..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: FlowcontrolApiserverApi -title: FlowcontrolApiserverApi -sidebar_label: FlowcontrolApiserverApi -sidebar_position: 6 ---- -# FlowcontrolApiserverApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/other/FlowcontrolApiserverApi#getAPIGroup) | **GET** /apis/flowcontrol.apiserver.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverV1Api.md deleted file mode 100644 index e4a02865c2d..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/FlowcontrolApiserverV1Api.md +++ /dev/null @@ -1,2147 +0,0 @@ ---- -id: FlowcontrolApiserverV1Api -title: FlowcontrolApiserverV1Api -sidebar_label: FlowcontrolApiserverV1Api -sidebar_position: 7 ---- -# FlowcontrolApiserverV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#createFlowSchema) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**createPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#createPriorityLevelConfiguration) | **POST** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**deleteCollectionFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteCollectionFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**deleteCollectionPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteCollectionPriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**deleteFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deleteFlowSchema) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**deletePriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#deletePriorityLevelConfiguration) | **DELETE** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**getAPIResources**](/docs/api-reference/other/FlowcontrolApiserverV1Api#getAPIResources) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/ | -[**listFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#listFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas | -[**listPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#listPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations | -[**patchFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchFlowSchema) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**patchFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchFlowSchemaStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**patchPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchPriorityLevelConfiguration) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**patchPriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#patchPriorityLevelConfigurationStatus) | **PATCH** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | -[**readFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readFlowSchema) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**readFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readFlowSchemaStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**readPriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readPriorityLevelConfiguration) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**readPriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#readPriorityLevelConfigurationStatus) | **GET** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | -[**replaceFlowSchema**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replaceFlowSchema) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name} | -[**replaceFlowSchemaStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replaceFlowSchemaStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status | -[**replacePriorityLevelConfiguration**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replacePriorityLevelConfiguration) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name} | -[**replacePriorityLevelConfigurationStatus**](/docs/api-reference/other/FlowcontrolApiserverV1Api#replacePriorityLevelConfigurationStatus) | **PUT** /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status | - -### createFlowSchema - - - -> V1FlowSchema createFlowSchema(body) - -create a FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiCreateFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiCreateFlowSchemaRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createPriorityLevelConfiguration - - - -> V1PriorityLevelConfiguration createPriorityLevelConfiguration(body) - -create a PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionFlowSchema - - - -> V1Status deleteCollectionFlowSchema() - -delete collection of FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionPriorityLevelConfiguration - - - -> V1Status deleteCollectionPriorityLevelConfiguration() - -delete collection of PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteFlowSchema - - - -> V1Status deleteFlowSchema() - -delete a FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deletePriorityLevelConfiguration - - - -> V1Status deletePriorityLevelConfiguration() - -delete a PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deletePriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listFlowSchema - - - -> V1FlowSchemaList listFlowSchema() - -list or watch objects of kind FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiListFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiListFlowSchemaRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1FlowSchemaList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPriorityLevelConfiguration - - - -> V1PriorityLevelConfigurationList listPriorityLevelConfiguration() - -list or watch objects of kind PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfigurationList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchFlowSchema - - - -> V1FlowSchema patchFlowSchema(body) - -partially update the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiPatchFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchFlowSchemaStatus - - - -> V1FlowSchema patchFlowSchemaStatus(body) - -partially update status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchPriorityLevelConfiguration - - - -> V1PriorityLevelConfiguration patchPriorityLevelConfiguration(body) - -partially update the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchPriorityLevelConfigurationStatus - - - -> V1PriorityLevelConfiguration patchPriorityLevelConfigurationStatus(body) - -partially update status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchPriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readFlowSchema - - - -> V1FlowSchema readFlowSchema() - -read the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReadFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readFlowSchemaStatus - - - -> V1FlowSchema readFlowSchemaStatus() - -read status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readPriorityLevelConfiguration - - - -> V1PriorityLevelConfiguration readPriorityLevelConfiguration() - -read the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readPriorityLevelConfigurationStatus - - - -> V1PriorityLevelConfiguration readPriorityLevelConfigurationStatus() - -read status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readPriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceFlowSchema - - - -> V1FlowSchema replaceFlowSchema(body) - -replace the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest = { - // name of the FlowSchema - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceFlowSchema(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceFlowSchemaStatus - - - -> V1FlowSchema replaceFlowSchemaStatus(body) - -replace status of the specified FlowSchema - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest = { - // name of the FlowSchema - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - distinguisherMethod: { - type: "type_example", - }, - matchingPrecedence: 1, - priorityLevelConfiguration: { - name: "name_example", - }, - rules: [ - { - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - clusterScope: true, - namespaces: [ - "namespaces_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - subjects: [ - { - group: { - name: "name_example", - }, - kind: "kind_example", - serviceAccount: { - name: "name_example", - namespace: "namespace_example", - }, - user: { - name: "name_example", - }, - }, - ], - }, - ], - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceFlowSchemaStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1FlowSchema**| | - **name** | [**string**] | name of the FlowSchema | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1FlowSchema - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replacePriorityLevelConfiguration - - - -> V1PriorityLevelConfiguration replacePriorityLevelConfiguration(body) - -replace the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityLevelConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replacePriorityLevelConfigurationStatus - - - -> V1PriorityLevelConfiguration replacePriorityLevelConfigurationStatus(body) - -replace status of the specified PriorityLevelConfiguration - -### Example - - -```typescript -import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node'; -import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new FlowcontrolApiserverV1Api(configuration); - -const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest = { - // name of the PriorityLevelConfiguration - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - exempt: { - lendablePercent: 1, - nominalConcurrencyShares: 1, - }, - limited: { - borrowingLimitPercent: 1, - lendablePercent: 1, - limitResponse: { - queuing: { - handSize: 1, - queueLengthLimit: 1, - queues: 1, - }, - type: "type_example", - }, - nominalConcurrencyShares: 1, - }, - type: "type_example", - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replacePriorityLevelConfigurationStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1PriorityLevelConfiguration**| | - **name** | [**string**] | name of the PriorityLevelConfiguration | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1PriorityLevelConfiguration - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverApi.md deleted file mode 100644 index 004c2a11502..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: InternalApiserverApi -title: InternalApiserverApi -sidebar_label: InternalApiserverApi -sidebar_position: 8 ---- -# InternalApiserverApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/other/InternalApiserverApi#getAPIGroup) | **GET** /apis/internal.apiserver.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, InternalApiserverApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverV1alpha1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverV1alpha1Api.md deleted file mode 100644 index dad0d5fc68c..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/InternalApiserverV1alpha1Api.md +++ /dev/null @@ -1,1037 +0,0 @@ ---- -id: InternalApiserverV1alpha1Api -title: InternalApiserverV1alpha1Api -sidebar_label: InternalApiserverV1alpha1Api -sidebar_position: 9 ---- -# InternalApiserverV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#createStorageVersion) | **POST** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**deleteCollectionStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#deleteCollectionStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**deleteStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#deleteStorageVersion) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**getAPIResources**](/docs/api-reference/other/InternalApiserverV1alpha1Api#getAPIResources) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/ | -[**listStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#listStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions | -[**patchStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#patchStorageVersion) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**patchStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#patchStorageVersionStatus) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | -[**readStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#readStorageVersion) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**readStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#readStorageVersionStatus) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | -[**replaceStorageVersion**](/docs/api-reference/other/InternalApiserverV1alpha1Api#replaceStorageVersion) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} | -[**replaceStorageVersionStatus**](/docs/api-reference/other/InternalApiserverV1alpha1Api#replaceStorageVersionStatus) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status | - -### createStorageVersion - - - -> V1alpha1StorageVersion createStorageVersion(body) - -create a StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiCreateStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiCreateStorageVersionRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionStorageVersion - - - -> V1Status deleteCollectionStorageVersion() - -delete collection of StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiDeleteCollectionStorageVersionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteStorageVersion - - - -> V1Status deleteStorageVersion() - -delete a StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiDeleteStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiDeleteStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listStorageVersion - - - -> V1alpha1StorageVersionList listStorageVersion() - -list or watch objects of kind StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiListStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiListStorageVersionRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersionList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchStorageVersion - - - -> V1alpha1StorageVersion patchStorageVersion(body) - -partially update the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiPatchStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiPatchStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchStorageVersionStatus - - - -> V1alpha1StorageVersion patchStorageVersionStatus(body) - -partially update status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiPatchStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readStorageVersion - - - -> V1alpha1StorageVersion readStorageVersion() - -read the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiReadStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReadStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readStorageVersionStatus - - - -> V1alpha1StorageVersion readStorageVersionStatus() - -read status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReadStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceStorageVersion - - - -> V1alpha1StorageVersion replaceStorageVersion(body) - -replace the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiReplaceStorageVersionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReplaceStorageVersionRequest = { - // name of the StorageVersion - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersion(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceStorageVersionStatus - - - -> V1alpha1StorageVersion replaceStorageVersionStatus(body) - -replace status of the specified StorageVersion - -### Example - - -```typescript -import { createConfiguration, InternalApiserverV1alpha1Api } from '@kubernetes/client-node'; -import type { InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new InternalApiserverV1alpha1Api(configuration); - -const request: InternalApiserverV1alpha1ApiReplaceStorageVersionStatusRequest = { - // name of the StorageVersion - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: {}, - status: { - commonEncodingVersion: "commonEncodingVersion_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - storageVersions: [ - { - apiServerID: "apiServerID_example", - decodableVersions: [ - "decodableVersions_example", - ], - encodingVersion: "encodingVersion_example", - servedVersions: [ - "servedVersions_example", - ], - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceStorageVersionStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1StorageVersion**| | - **name** | [**string**] | name of the StorageVersion | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1StorageVersion - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/LogsApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/LogsApi.md deleted file mode 100644 index 6b4953a3eea..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/LogsApi.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: LogsApi -title: LogsApi -sidebar_label: LogsApi -sidebar_position: 10 ---- -# LogsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**logFileHandler**](/docs/api-reference/other/LogsApi#logFileHandler) | **GET** /logs/{logpath} | -[**logFileListHandler**](/docs/api-reference/other/LogsApi#logFileListHandler) | **GET** /logs/ | - -### logFileHandler - - - -> logFileHandler() - -### Example - - -```typescript -import { createConfiguration, LogsApi } from '@kubernetes/client-node'; -import type { LogsApiLogFileHandlerRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new LogsApi(configuration); - -const request: LogsApiLogFileHandlerRequest = { - // path to the log - logpath: "logpath_example", -}; - -const data = await apiInstance.logFileHandler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **logpath** | [**string**] | path to the log | defaults to undefined - -### Return type - -void (empty response body) - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**401** | Unauthorized | - | - -### logFileListHandler - - - -> logFileListHandler() - -### Example - - -```typescript -import { createConfiguration, LogsApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new LogsApi(configuration); - -const request = {}; - -const data = await apiInstance.logFileListHandler(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/OpenidApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/OpenidApi.md deleted file mode 100644 index 7c54bab7421..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/OpenidApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: OpenidApi -title: OpenidApi -sidebar_label: OpenidApi -sidebar_position: 11 ---- -# OpenidApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getServiceAccountIssuerOpenIDKeyset**](/docs/api-reference/other/OpenidApi#getServiceAccountIssuerOpenIDKeyset) | **GET** /openid/v1/jwks | - -### getServiceAccountIssuerOpenIDKeyset - - - -> string getServiceAccountIssuerOpenIDKeyset() - -get service account issuer OpenID JSON Web Key Set (contains public token verification keys) - -### Example - - -```typescript -import { createConfiguration, OpenidApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new OpenidApi(configuration); - -const request = {}; - -const data = await apiInstance.getServiceAccountIssuerOpenIDKeyset(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/jwk-set+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceApi.md deleted file mode 100644 index 4f03d6331c3..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: ResourceApi -title: ResourceApi -sidebar_label: ResourceApi -sidebar_position: 12 ---- -# ResourceApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/other/ResourceApi#getAPIGroup) | **GET** /apis/resource.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, ResourceApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1Api.md deleted file mode 100644 index f5608ee68dc..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1Api.md +++ /dev/null @@ -1,4243 +0,0 @@ ---- -id: ResourceV1Api -title: ResourceV1Api -sidebar_label: ResourceV1Api -sidebar_position: 14 ---- -# ResourceV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](/docs/api-reference/other/ResourceV1Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1/deviceclasses | -[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](/docs/api-reference/other/ResourceV1Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1/resourceslices | -[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices | -[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**getAPIResources**](/docs/api-reference/other/ResourceV1Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1/ | -[**listDeviceClass**](/docs/api-reference/other/ResourceV1Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses | -[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1/resourceclaimtemplates | -[**listResourceSlice**](/docs/api-reference/other/ResourceV1Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices | -[**patchDeviceClass**](/docs/api-reference/other/ResourceV1Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](/docs/api-reference/other/ResourceV1Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**readDeviceClass**](/docs/api-reference/other/ResourceV1Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](/docs/api-reference/other/ResourceV1Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1/resourceslices/{name} | -[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1/resourceslices/{name} | - -### createDeviceClass - - - -> V1DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaim - - - -> ResourceV1ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createResourceSlice - - - -> V1ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionDeviceClass - - - -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaim - - - -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaimTemplate - - - -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionResourceSlice - - - -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteDeviceClass - - - -> V1DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaim - - - -> ResourceV1ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteResourceSlice - - - -> V1ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeviceClass - - - -> V1DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DeviceClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaim - - - -> V1ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimForAllNamespaces - - - -> V1ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimTemplateForAllNamespaces - - - -> V1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceSlice - - - -> V1ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiListResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ResourceSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchDeviceClass - - - -> V1DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaim - - - -> ResourceV1ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimStatus - - - -> ResourceV1ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchResourceSlice - - - -> V1ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readDeviceClass - - - -> V1DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaim - - - -> ResourceV1ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimStatus - - - -> ResourceV1ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readResourceSlice - - - -> V1ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReadResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceDeviceClass - - - -> V1DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaim - - - -> ResourceV1ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimStatus - - - -> ResourceV1ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **ResourceV1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -ResourceV1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimTemplate - - - -> V1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceResourceSlice - - - -> V1ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node'; -import type { ResourceV1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1Api(configuration); - -const request: ResourceV1ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1alpha3Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1alpha3Api.md deleted file mode 100644 index 422afac65e5..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1alpha3Api.md +++ /dev/null @@ -1,1034 +0,0 @@ ---- -id: ResourceV1alpha3Api -title: ResourceV1alpha3Api -sidebar_label: ResourceV1alpha3Api -sidebar_position: 13 ---- -# ResourceV1alpha3Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#createDeviceTaintRule) | **POST** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**deleteCollectionDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#deleteCollectionDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**deleteDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#deleteDeviceTaintRule) | **DELETE** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**getAPIResources**](/docs/api-reference/other/ResourceV1alpha3Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1alpha3/ | -[**listDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#listDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules | -[**patchDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#patchDeviceTaintRule) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**patchDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#patchDeviceTaintRuleStatus) | **PATCH** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | -[**readDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#readDeviceTaintRule) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**readDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#readDeviceTaintRuleStatus) | **GET** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | -[**replaceDeviceTaintRule**](/docs/api-reference/other/ResourceV1alpha3Api#replaceDeviceTaintRule) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name} | -[**replaceDeviceTaintRuleStatus**](/docs/api-reference/other/ResourceV1alpha3Api#replaceDeviceTaintRuleStatus) | **PUT** /apis/resource.k8s.io/v1alpha3/devicetaintrules/{name}/status | - -### createDeviceTaintRule - - - -> V1alpha3DeviceTaintRule createDeviceTaintRule(body) - -create a DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiCreateDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiCreateDeviceTaintRuleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionDeviceTaintRule - - - -> V1Status deleteCollectionDeviceTaintRule() - -delete collection of DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiDeleteCollectionDeviceTaintRuleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteDeviceTaintRule - - - -> V1alpha3DeviceTaintRule deleteDeviceTaintRule() - -delete a DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiDeleteDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeviceTaintRule - - - -> V1alpha3DeviceTaintRuleList listDeviceTaintRule() - -list or watch objects of kind DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiListDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiListDeviceTaintRuleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRuleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchDeviceTaintRule - - - -> V1alpha3DeviceTaintRule patchDeviceTaintRule(body) - -partially update the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiPatchDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiPatchDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchDeviceTaintRuleStatus - - - -> V1alpha3DeviceTaintRule patchDeviceTaintRuleStatus(body) - -partially update status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiPatchDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readDeviceTaintRule - - - -> V1alpha3DeviceTaintRule readDeviceTaintRule() - -read the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiReadDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReadDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readDeviceTaintRuleStatus - - - -> V1alpha3DeviceTaintRule readDeviceTaintRuleStatus() - -read status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReadDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceDeviceTaintRule - - - -> V1alpha3DeviceTaintRule replaceDeviceTaintRule(body) - -replace the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceTaintRule(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceDeviceTaintRuleStatus - - - -> V1alpha3DeviceTaintRule replaceDeviceTaintRuleStatus(body) - -replace status of the specified DeviceTaintRule - -### Example - - -```typescript -import { createConfiguration, ResourceV1alpha3Api } from '@kubernetes/client-node'; -import type { ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1alpha3Api(configuration); - -const request: ResourceV1alpha3ApiReplaceDeviceTaintRuleStatusRequest = { - // name of the DeviceTaintRule - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - deviceSelector: { - device: "device_example", - driver: "driver_example", - pool: "pool_example", - }, - taint: { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - }, - status: { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceTaintRuleStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha3DeviceTaintRule**| | - **name** | [**string**] | name of the DeviceTaintRule | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha3DeviceTaintRule - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta1Api.md deleted file mode 100644 index 45b5addc503..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta1Api.md +++ /dev/null @@ -1,4237 +0,0 @@ ---- -id: ResourceV1beta1Api -title: ResourceV1beta1Api -sidebar_label: ResourceV1beta1Api -sidebar_position: 15 ---- -# ResourceV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta1/resourceslices | -[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices | -[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**getAPIResources**](/docs/api-reference/other/ResourceV1beta1Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta1/ | -[**listDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses | -[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1beta1Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1beta1Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta1/resourceclaimtemplates | -[**listResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices | -[**patchDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**readDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | -[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1beta1Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta1/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta1Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1beta1Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta1/resourceslices/{name} | - -### createDeviceClass - - - -> V1beta1DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaim - - - -> V1beta1ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createResourceSlice - - - -> V1beta1ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - basic: { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - name: "name_example", - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionDeviceClass - - - -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaim - - - -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaimTemplate - - - -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionResourceSlice - - - -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteDeviceClass - - - -> V1beta1DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaim - - - -> V1beta1ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteResourceSlice - - - -> V1beta1ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeviceClass - - - -> V1beta1DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaim - - - -> V1beta1ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimForAllNamespaces - - - -> V1beta1ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimTemplateForAllNamespaces - - - -> V1beta1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceSlice - - - -> V1beta1ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiListResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchDeviceClass - - - -> V1beta1DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaim - - - -> V1beta1ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimStatus - - - -> V1beta1ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchResourceSlice - - - -> V1beta1ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readDeviceClass - - - -> V1beta1DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaim - - - -> V1beta1ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimStatus - - - -> V1beta1ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readResourceSlice - - - -> V1beta1ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReadResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceDeviceClass - - - -> V1beta1DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaim - - - -> V1beta1ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimStatus - - - -> V1beta1ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimTemplate - - - -> V1beta1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceResourceSlice - - - -> V1beta1ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta1Api } from '@kubernetes/client-node'; -import type { ResourceV1beta1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta1Api(configuration); - -const request: ResourceV1beta1ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - basic: { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - name: "name_example", - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta2Api.md b/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta2Api.md deleted file mode 100644 index 63718ec328b..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/ResourceV1beta2Api.md +++ /dev/null @@ -1,4243 +0,0 @@ ---- -id: ResourceV1beta2Api -title: ResourceV1beta2Api -sidebar_label: ResourceV1beta2Api -sidebar_position: 16 ---- -# ResourceV1beta2Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#createDeviceClass) | **POST** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**createNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#createNamespacedResourceClaim) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**createNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#createNamespacedResourceClaimTemplate) | **POST** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**createResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#createResourceSlice) | **POST** /apis/resource.k8s.io/v1beta2/resourceslices | -[**deleteCollectionDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**deleteCollectionNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**deleteCollectionNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**deleteCollectionResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#deleteCollectionResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices | -[**deleteDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#deleteDeviceClass) | **DELETE** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**deleteNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#deleteNamespacedResourceClaim) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**deleteNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#deleteNamespacedResourceClaimTemplate) | **DELETE** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**deleteResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#deleteResourceSlice) | **DELETE** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**getAPIResources**](/docs/api-reference/other/ResourceV1beta2Api#getAPIResources) | **GET** /apis/resource.k8s.io/v1beta2/ | -[**listDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#listDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses | -[**listNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#listNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims | -[**listNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#listNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates | -[**listResourceClaimForAllNamespaces**](/docs/api-reference/other/ResourceV1beta2Api#listResourceClaimForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaims | -[**listResourceClaimTemplateForAllNamespaces**](/docs/api-reference/other/ResourceV1beta2Api#listResourceClaimTemplateForAllNamespaces) | **GET** /apis/resource.k8s.io/v1beta2/resourceclaimtemplates | -[**listResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#listResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices | -[**patchDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#patchDeviceClass) | **PATCH** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**patchNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaim) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**patchNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaimStatus) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**patchNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#patchNamespacedResourceClaimTemplate) | **PATCH** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**patchResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#patchResourceSlice) | **PATCH** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**readDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#readDeviceClass) | **GET** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**readNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaim) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**readNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaimStatus) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**readNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#readNamespacedResourceClaimTemplate) | **GET** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**readResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#readResourceSlice) | **GET** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | -[**replaceDeviceClass**](/docs/api-reference/other/ResourceV1beta2Api#replaceDeviceClass) | **PUT** /apis/resource.k8s.io/v1beta2/deviceclasses/{name} | -[**replaceNamespacedResourceClaim**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaim) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name} | -[**replaceNamespacedResourceClaimStatus**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaimStatus) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaims/{name}/status | -[**replaceNamespacedResourceClaimTemplate**](/docs/api-reference/other/ResourceV1beta2Api#replaceNamespacedResourceClaimTemplate) | **PUT** /apis/resource.k8s.io/v1beta2/namespaces/{namespace}/resourceclaimtemplates/{name} | -[**replaceResourceSlice**](/docs/api-reference/other/ResourceV1beta2Api#replaceResourceSlice) | **PUT** /apis/resource.k8s.io/v1beta2/resourceslices/{name} | - -### createDeviceClass - - - -> V1beta2DeviceClass createDeviceClass(body) - -create a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiCreateDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateDeviceClassRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2DeviceClass**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaim - - - -> V1beta2ResourceClaim createNamespacedResourceClaim(body) - -create a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate createNamespacedResourceClaimTemplate(body) - -create a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaimTemplate**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createResourceSlice - - - -> V1beta2ResourceSlice createResourceSlice(body) - -create a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiCreateResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiCreateResourceSliceRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceSlice**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionDeviceClass - - - -> V1Status deleteCollectionDeviceClass() - -delete collection of DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaim - - - -> V1Status deleteCollectionNamespacedResourceClaim() - -delete collection of ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedResourceClaimTemplate - - - -> V1Status deleteCollectionNamespacedResourceClaimTemplate() - -delete collection of ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionResourceSlice - - - -> V1Status deleteCollectionResourceSlice() - -delete collection of ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteCollectionResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteDeviceClass - - - -> V1beta2DeviceClass deleteDeviceClass() - -delete a DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaim - - - -> V1beta2ResourceClaim deleteNamespacedResourceClaim() - -delete a ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate deleteNamespacedResourceClaimTemplate() - -delete a ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteResourceSlice - - - -> V1beta2ResourceSlice deleteResourceSlice() - -delete a ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiDeleteResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiDeleteResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeviceClass - - - -> V1beta2DeviceClassList listDeviceClass() - -list or watch objects of kind DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListDeviceClassRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClassList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaim - - - -> V1beta2ResourceClaimList listNamespacedResourceClaim() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListNamespacedResourceClaimRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplateList listNamespacedResourceClaimTemplate() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListNamespacedResourceClaimTemplateRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimForAllNamespaces - - - -> V1beta2ResourceClaimList listResourceClaimForAllNamespaces() - -list or watch objects of kind ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceClaimForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceClaimTemplateForAllNamespaces - - - -> V1beta2ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces() - -list or watch objects of kind ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceClaimTemplateForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceClaimTemplateForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplateList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listResourceSlice - - - -> V1beta2ResourceSliceList listResourceSlice() - -list or watch objects of kind ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiListResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiListResourceSliceRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSliceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchDeviceClass - - - -> V1beta2DeviceClass patchDeviceClass(body) - -partially update the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaim - - - -> V1beta2ResourceClaim patchNamespacedResourceClaim(body) - -partially update the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimStatus - - - -> V1beta2ResourceClaim patchNamespacedResourceClaimStatus(body) - -partially update status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body) - -partially update the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchResourceSlice - - - -> V1beta2ResourceSlice patchResourceSlice(body) - -partially update the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiPatchResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiPatchResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readDeviceClass - - - -> V1beta2DeviceClass readDeviceClass() - -read the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaim - - - -> V1beta2ResourceClaim readNamespacedResourceClaim() - -read the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimStatus - - - -> V1beta2ResourceClaim readNamespacedResourceClaimStatus() - -read status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate readNamespacedResourceClaimTemplate() - -read the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readResourceSlice - - - -> V1beta2ResourceSlice readResourceSlice() - -read the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReadResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReadResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceDeviceClass - - - -> V1beta2DeviceClass replaceDeviceClass(body) - -replace the specified DeviceClass - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceDeviceClassRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceDeviceClassRequest = { - // name of the DeviceClass - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - }, - ], - extendedResourceName: "extendedResourceName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceDeviceClass(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2DeviceClass**| | - **name** | [**string**] | name of the DeviceClass | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2DeviceClass - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaim - - - -> V1beta2ResourceClaim replaceNamespacedResourceClaim(body) - -replace the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaim(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimStatus - - - -> V1beta2ResourceClaim replaceNamespacedResourceClaimStatus(body) - -replace status of the specified ResourceClaim - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimStatusRequest = { - // name of the ResourceClaim - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - status: { - allocation: { - allocationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - source: "source_example", - }, - ], - results: [ - { - adminAccess: true, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - consumedCapacity: { - "key": "key_example", - }, - device: "device_example", - driver: "driver_example", - pool: "pool_example", - request: "request_example", - shareID: "shareID_example", - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - }, - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - devices: [ - { - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - data: {}, - device: "device_example", - driver: "driver_example", - networkData: { - hardwareAddress: "hardwareAddress_example", - interfaceName: "interfaceName_example", - ips: [ - "ips_example", - ], - }, - pool: "pool_example", - shareID: "shareID_example", - }, - ], - reservedFor: [ - { - apiGroup: "apiGroup_example", - name: "name_example", - resource: "resource_example", - uid: "uid_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaim**| | - **name** | [**string**] | name of the ResourceClaim | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaim - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedResourceClaimTemplate - - - -> V1beta2ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body) - -replace the specified ResourceClaimTemplate - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceNamespacedResourceClaimTemplateRequest = { - // name of the ResourceClaimTemplate - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - devices: { - config: [ - { - opaque: { - driver: "driver_example", - parameters: {}, - }, - requests: [ - "requests_example", - ], - }, - ], - constraints: [ - { - distinctAttribute: "distinctAttribute_example", - matchAttribute: "matchAttribute_example", - requests: [ - "requests_example", - ], - }, - ], - requests: [ - { - exactly: { - adminAccess: true, - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - firstAvailable: [ - { - allocationMode: "allocationMode_example", - capacity: { - requests: { - "key": "key_example", - }, - }, - count: 1, - deviceClassName: "deviceClassName_example", - name: "name_example", - selectors: [ - { - cel: { - expression: "expression_example", - }, - }, - ], - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - }, - ], - name: "name_example", - }, - ], - }, - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceClaimTemplate**| | - **name** | [**string**] | name of the ResourceClaimTemplate | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceClaimTemplate - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceResourceSlice - - - -> V1beta2ResourceSlice replaceResourceSlice(body) - -replace the specified ResourceSlice - -### Example - - -```typescript -import { createConfiguration, ResourceV1beta2Api } from '@kubernetes/client-node'; -import type { ResourceV1beta2ApiReplaceResourceSliceRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new ResourceV1beta2Api(configuration); - -const request: ResourceV1beta2ApiReplaceResourceSliceRequest = { - // name of the ResourceSlice - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - allNodes: true, - devices: [ - { - allNodes: true, - allowMultipleAllocations: true, - attributes: { - "key": { - bool: true, - _int: 1, - string: "string_example", - version: "version_example", - }, - }, - bindingConditions: [ - "bindingConditions_example", - ], - bindingFailureConditions: [ - "bindingFailureConditions_example", - ], - bindsToNode: true, - capacity: { - "key": { - requestPolicy: { - _default: "_default_example", - validRange: { - max: "max_example", - min: "min_example", - step: "step_example", - }, - validValues: [ - "validValues_example", - ], - }, - value: "value_example", - }, - }, - consumesCounters: [ - { - counterSet: "counterSet_example", - counters: { - "key": { - value: "value_example", - }, - }, - }, - ], - name: "name_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - taints: [ - { - effect: "effect_example", - key: "key_example", - timeAdded: new Date('1970-01-01T00:00:00.00Z'), - value: "value_example", - }, - ], - }, - ], - driver: "driver_example", - nodeName: "nodeName_example", - nodeSelector: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - perDeviceNodeSelection: true, - pool: { - generation: 1, - name: "name_example", - resourceSliceCount: 1, - }, - sharedCounters: [ - { - counters: { - "key": { - value: "value_example", - }, - }, - name: "name_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceResourceSlice(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta2ResourceSlice**| | - **name** | [**string**] | name of the ResourceSlice | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta2ResourceSlice - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/VersionApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/VersionApi.md deleted file mode 100644 index 4bcec0125a1..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/VersionApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: VersionApi -title: VersionApi -sidebar_label: VersionApi -sidebar_position: 17 ---- -# VersionApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getCode**](/docs/api-reference/other/VersionApi#getCode) | **GET** /version/ | - -### getCode - - - -> VersionInfo getCode() - -get the version information for this server - -### Example - - -```typescript -import { createConfiguration, VersionApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new VersionApi(configuration); - -const request = {}; - -const data = await apiInstance.getCode(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -VersionInfo - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/WellKnownApi.md b/website/versioned_docs/version-2.0.0/api-reference/other/WellKnownApi.md deleted file mode 100644 index e3550313146..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/WellKnownApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: WellKnownApi -title: WellKnownApi -sidebar_label: WellKnownApi -sidebar_position: 18 ---- -# WellKnownApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getServiceAccountIssuerOpenIDConfiguration**](/docs/api-reference/other/WellKnownApi#getServiceAccountIssuerOpenIDConfiguration) | **GET** /.well-known/openid-configuration | - -### getServiceAccountIssuerOpenIDConfiguration - - - -> string getServiceAccountIssuerOpenIDConfiguration() - -get service account issuer OpenID configuration, also known as the \'OIDC discovery doc\' - -### Example - - -```typescript -import { createConfiguration, WellKnownApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new WellKnownApi(configuration); - -const request = {}; - -const data = await apiInstance.getServiceAccountIssuerOpenIDConfiguration(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -string - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/other/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/other/_category_.json deleted file mode 100644 index ea3276e897e..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/other/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Other", - "position": 7 -} diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationApi.md b/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationApi.md deleted file mode 100644 index 87462a1c002..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AuthenticationApi -title: AuthenticationApi -sidebar_label: AuthenticationApi -sidebar_position: 1 ---- -# AuthenticationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/security/AuthenticationApi#getAPIGroup) | **GET** /apis/authentication.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AuthenticationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationV1Api.md deleted file mode 100644 index ea08df6db06..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/AuthenticationV1Api.md +++ /dev/null @@ -1,329 +0,0 @@ ---- -id: AuthenticationV1Api -title: AuthenticationV1Api -sidebar_label: AuthenticationV1Api -sidebar_position: 2 ---- -# AuthenticationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createSelfSubjectReview**](/docs/api-reference/security/AuthenticationV1Api#createSelfSubjectReview) | **POST** /apis/authentication.k8s.io/v1/selfsubjectreviews | -[**createTokenReview**](/docs/api-reference/security/AuthenticationV1Api#createTokenReview) | **POST** /apis/authentication.k8s.io/v1/tokenreviews | -[**getAPIResources**](/docs/api-reference/security/AuthenticationV1Api#getAPIResources) | **GET** /apis/authentication.k8s.io/v1/ | - -### createSelfSubjectReview - - - -> V1SelfSubjectReview createSelfSubjectReview(body) - -create a SelfSubjectReview - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; -import type { AuthenticationV1ApiCreateSelfSubjectReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request: AuthenticationV1ApiCreateSelfSubjectReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - status: { - userInfo: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - uid: "uid_example", - username: "username_example", - }, - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1SelfSubjectReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createTokenReview - - - -> V1TokenReview createTokenReview(body) - -create a TokenReview - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; -import type { AuthenticationV1ApiCreateTokenReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request: AuthenticationV1ApiCreateTokenReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - audiences: [ - "audiences_example", - ], - token: "token_example", - }, - status: { - audiences: [ - "audiences_example", - ], - authenticated: true, - error: "error_example", - user: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - uid: "uid_example", - username: "username_example", - }, - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createTokenReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1TokenReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1TokenReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthenticationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationApi.md b/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationApi.md deleted file mode 100644 index 8a455c1507a..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AuthorizationApi -title: AuthorizationApi -sidebar_label: AuthorizationApi -sidebar_position: 3 ---- -# AuthorizationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/security/AuthorizationApi#getAPIGroup) | **GET** /apis/authorization.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AuthorizationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationV1Api.md deleted file mode 100644 index f93a906688b..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/AuthorizationV1Api.md +++ /dev/null @@ -1,709 +0,0 @@ ---- -id: AuthorizationV1Api -title: AuthorizationV1Api -sidebar_label: AuthorizationV1Api -sidebar_position: 4 ---- -# AuthorizationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedLocalSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createNamespacedLocalSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews | -[**createSelfSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createSelfSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectaccessreviews | -[**createSelfSubjectRulesReview**](/docs/api-reference/security/AuthorizationV1Api#createSelfSubjectRulesReview) | **POST** /apis/authorization.k8s.io/v1/selfsubjectrulesreviews | -[**createSubjectAccessReview**](/docs/api-reference/security/AuthorizationV1Api#createSubjectAccessReview) | **POST** /apis/authorization.k8s.io/v1/subjectaccessreviews | -[**getAPIResources**](/docs/api-reference/security/AuthorizationV1Api#getAPIResources) | **GET** /apis/authorization.k8s.io/v1/ | - -### createNamespacedLocalSubjectAccessReview - - - -> V1LocalSubjectAccessReview createNamespacedLocalSubjectAccessReview(body) - -create a LocalSubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; -import type { AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - uid: "uid_example", - user: "user_example", - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createNamespacedLocalSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1LocalSubjectAccessReview**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1LocalSubjectAccessReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createSelfSubjectAccessReview - - - -> V1SelfSubjectAccessReview createSelfSubjectAccessReview(body) - -create a SelfSubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; -import type { AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectAccessReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1SelfSubjectAccessReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createSelfSubjectRulesReview - - - -> V1SelfSubjectRulesReview createSelfSubjectRulesReview(body) - -create a SelfSubjectRulesReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; -import type { AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - namespace: "namespace_example", - }, - status: { - evaluationError: "evaluationError_example", - incomplete: true, - nonResourceRules: [ - { - nonResourceURLs: [ - "nonResourceURLs_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - resourceRules: [ - { - apiGroups: [ - "apiGroups_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSelfSubjectRulesReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SelfSubjectRulesReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1SelfSubjectRulesReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createSubjectAccessReview - - - -> V1SubjectAccessReview createSubjectAccessReview(body) - -create a SubjectAccessReview - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; -import type { AuthorizationV1ApiCreateSubjectAccessReviewRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request: AuthorizationV1ApiCreateSubjectAccessReviewRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - nonResourceAttributes: { - path: "path_example", - verb: "verb_example", - }, - resourceAttributes: { - fieldSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - group: "group_example", - labelSelector: { - rawSelector: "rawSelector_example", - requirements: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - name: "name_example", - namespace: "namespace_example", - resource: "resource_example", - subresource: "subresource_example", - verb: "verb_example", - version: "version_example", - }, - uid: "uid_example", - user: "user_example", - }, - status: { - allowed: true, - denied: true, - evaluationError: "evaluationError_example", - reason: "reason_example", - }, - }, - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.createSubjectAccessReview(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1SubjectAccessReview**| | - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1SubjectAccessReview - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AuthorizationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesApi.md b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesApi.md deleted file mode 100644 index 64655347e16..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: CertificatesApi -title: CertificatesApi -sidebar_label: CertificatesApi -sidebar_position: 5 ---- -# CertificatesApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/security/CertificatesApi#getAPIGroup) | **GET** /apis/certificates.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, CertificatesApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1Api.md deleted file mode 100644 index 115c9de03cb..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1Api.md +++ /dev/null @@ -1,1331 +0,0 @@ ---- -id: CertificatesV1Api -title: CertificatesV1Api -sidebar_label: CertificatesV1Api -sidebar_position: 7 ---- -# CertificatesV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#createCertificateSigningRequest) | **POST** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**deleteCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#deleteCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**deleteCollectionCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#deleteCollectionCertificateSigningRequest) | **DELETE** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**getAPIResources**](/docs/api-reference/security/CertificatesV1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1/ | -[**listCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#listCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests | -[**patchCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequest) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**patchCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequestApproval) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**patchCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#patchCertificateSigningRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | -[**readCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequest) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**readCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequestApproval) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**readCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#readCertificateSigningRequestStatus) | **GET** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | -[**replaceCertificateSigningRequest**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequest) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} | -[**replaceCertificateSigningRequestApproval**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequestApproval) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval | -[**replaceCertificateSigningRequestStatus**](/docs/api-reference/security/CertificatesV1Api#replaceCertificateSigningRequestStatus) | **PUT** /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status | - -### createCertificateSigningRequest - - - -> V1CertificateSigningRequest createCertificateSigningRequest(body) - -create a CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiCreateCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiCreateCertificateSigningRequestRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCertificateSigningRequest - - - -> V1Status deleteCertificateSigningRequest() - -delete a CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiDeleteCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiDeleteCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionCertificateSigningRequest - - - -> V1Status deleteCollectionCertificateSigningRequest() - -delete collection of CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiDeleteCollectionCertificateSigningRequestRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCertificateSigningRequest - - - -> V1CertificateSigningRequestList listCertificateSigningRequest() - -list or watch objects of kind CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiListCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiListCertificateSigningRequestRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequestList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchCertificateSigningRequest - - - -> V1CertificateSigningRequest patchCertificateSigningRequest(body) - -partially update the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiPatchCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchCertificateSigningRequestApproval - - - -> V1CertificateSigningRequest patchCertificateSigningRequestApproval(body) - -partially update approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchCertificateSigningRequestStatus - - - -> V1CertificateSigningRequest patchCertificateSigningRequestStatus(body) - -partially update status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiPatchCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiPatchCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readCertificateSigningRequest - - - -> V1CertificateSigningRequest readCertificateSigningRequest() - -read the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReadCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readCertificateSigningRequestApproval - - - -> V1CertificateSigningRequest readCertificateSigningRequestApproval() - -read approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReadCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readCertificateSigningRequestStatus - - - -> V1CertificateSigningRequest readCertificateSigningRequestStatus() - -read status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReadCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReadCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceCertificateSigningRequest - - - -> V1CertificateSigningRequest replaceCertificateSigningRequest(body) - -replace the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReplaceCertificateSigningRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceCertificateSigningRequestApproval - - - -> V1CertificateSigningRequest replaceCertificateSigningRequestApproval(body) - -replace approval of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestApprovalRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequestApproval(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceCertificateSigningRequestStatus - - - -> V1CertificateSigningRequest replaceCertificateSigningRequestStatus(body) - -replace status of the specified CertificateSigningRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1Api } from '@kubernetes/client-node'; -import type { CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1Api(configuration); - -const request: CertificatesV1ApiReplaceCertificateSigningRequestStatusRequest = { - // name of the CertificateSigningRequest - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - expirationSeconds: 1, - extra: { - "key": [ - "key_example", - ], - }, - groups: [ - "groups_example", - ], - request: 'YQ==', - signerName: "signerName_example", - uid: "uid_example", - usages: [ - "usages_example", - ], - username: "username_example", - }, - status: { - certificate: 'YQ==', - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceCertificateSigningRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CertificateSigningRequest**| | - **name** | [**string**] | name of the CertificateSigningRequest | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CertificateSigningRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1alpha1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1alpha1Api.md deleted file mode 100644 index 3d8fd7a66b4..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1alpha1Api.md +++ /dev/null @@ -1,719 +0,0 @@ ---- -id: CertificatesV1alpha1Api -title: CertificatesV1alpha1Api -sidebar_label: CertificatesV1alpha1Api -sidebar_position: 6 ---- -# CertificatesV1alpha1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**deleteClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**deleteCollectionClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**getAPIResources**](/docs/api-reference/security/CertificatesV1alpha1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1alpha1/ | -[**listClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles | -[**patchClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**readClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | -[**replaceClusterTrustBundle**](/docs/api-reference/security/CertificatesV1alpha1Api#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} | - -### createClusterTrustBundle - - - -> V1alpha1ClusterTrustBundle createClusterTrustBundle(body) - -create a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiCreateClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiCreateClusterTrustBundleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ClusterTrustBundle**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteClusterTrustBundle - - - -> V1Status deleteClusterTrustBundle() - -delete a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiDeleteClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterTrustBundle - - - -> V1Status deleteCollectionClusterTrustBundle() - -delete collection of ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiDeleteCollectionClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterTrustBundle - - - -> V1alpha1ClusterTrustBundleList listClusterTrustBundle() - -list or watch objects of kind ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiListClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiListClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterTrustBundle - - - -> V1alpha1ClusterTrustBundle patchClusterTrustBundle(body) - -partially update the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiPatchClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiPatchClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readClusterTrustBundle - - - -> V1alpha1ClusterTrustBundle readClusterTrustBundle() - -read the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiReadClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiReadClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterTrustBundle - - - -> V1alpha1ClusterTrustBundle replaceClusterTrustBundle(body) - -replace the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1alpha1Api } from '@kubernetes/client-node'; -import type { CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1alpha1Api(configuration); - -const request: CertificatesV1alpha1ApiReplaceClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1alpha1ClusterTrustBundle**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1alpha1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1beta1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1beta1Api.md deleted file mode 100644 index 5cef2659fca..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/CertificatesV1beta1Api.md +++ /dev/null @@ -1,1824 +0,0 @@ ---- -id: CertificatesV1beta1Api -title: CertificatesV1beta1Api -sidebar_label: CertificatesV1beta1Api -sidebar_position: 8 ---- -# CertificatesV1beta1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#createClusterTrustBundle) | **POST** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**createNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#createNamespacedPodCertificateRequest) | **POST** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**deleteClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#deleteClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**deleteCollectionClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#deleteCollectionClusterTrustBundle) | **DELETE** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**deleteCollectionNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#deleteCollectionNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**deleteNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#deleteNamespacedPodCertificateRequest) | **DELETE** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**getAPIResources**](/docs/api-reference/security/CertificatesV1beta1Api#getAPIResources) | **GET** /apis/certificates.k8s.io/v1beta1/ | -[**listClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#listClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles | -[**listNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#listNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests | -[**listPodCertificateRequestForAllNamespaces**](/docs/api-reference/security/CertificatesV1beta1Api#listPodCertificateRequestForAllNamespaces) | **GET** /apis/certificates.k8s.io/v1beta1/podcertificaterequests | -[**patchClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#patchClusterTrustBundle) | **PATCH** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**patchNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#patchNamespacedPodCertificateRequest) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**patchNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#patchNamespacedPodCertificateRequestStatus) | **PATCH** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | -[**readClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#readClusterTrustBundle) | **GET** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**readNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#readNamespacedPodCertificateRequest) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**readNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#readNamespacedPodCertificateRequestStatus) | **GET** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | -[**replaceClusterTrustBundle**](/docs/api-reference/security/CertificatesV1beta1Api#replaceClusterTrustBundle) | **PUT** /apis/certificates.k8s.io/v1beta1/clustertrustbundles/{name} | -[**replaceNamespacedPodCertificateRequest**](/docs/api-reference/security/CertificatesV1beta1Api#replaceNamespacedPodCertificateRequest) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name} | -[**replaceNamespacedPodCertificateRequestStatus**](/docs/api-reference/security/CertificatesV1beta1Api#replaceNamespacedPodCertificateRequestStatus) | **PUT** /apis/certificates.k8s.io/v1beta1/namespaces/{namespace}/podcertificaterequests/{name}/status | - -### createClusterTrustBundle - - - -> V1beta1ClusterTrustBundle createClusterTrustBundle(body) - -create a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiCreateClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiCreateClusterTrustBundleRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ClusterTrustBundle**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequest createNamespacedPodCertificateRequest(body) - -create a PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiCreateNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteClusterTrustBundle - - - -> V1Status deleteClusterTrustBundle() - -delete a ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiDeleteClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterTrustBundle - - - -> V1Status deleteCollectionClusterTrustBundle() - -delete collection of ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteCollectionClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedPodCertificateRequest - - - -> V1Status deleteCollectionNamespacedPodCertificateRequest() - -delete collection of PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteCollectionNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedPodCertificateRequest - - - -> V1Status deleteNamespacedPodCertificateRequest() - -delete a PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiDeleteNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterTrustBundle - - - -> V1beta1ClusterTrustBundleList listClusterTrustBundle() - -list or watch objects of kind ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiListClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListClusterTrustBundleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequestList listNamespacedPodCertificateRequest() - -list or watch objects of kind PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListNamespacedPodCertificateRequestRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequestList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listPodCertificateRequestForAllNamespaces - - - -> V1beta1PodCertificateRequestList listPodCertificateRequestForAllNamespaces() - -list or watch objects of kind PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiListPodCertificateRequestForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listPodCertificateRequestForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequestList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterTrustBundle - - - -> V1beta1ClusterTrustBundle patchClusterTrustBundle(body) - -partially update the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiPatchClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequest(body) - -partially update the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedPodCertificateRequestStatus - - - -> V1beta1PodCertificateRequest patchNamespacedPodCertificateRequestStatus(body) - -partially update status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiPatchNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readClusterTrustBundle - - - -> V1beta1ClusterTrustBundle readClusterTrustBundle() - -read the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReadClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequest readNamespacedPodCertificateRequest() - -read the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedPodCertificateRequestStatus - - - -> V1beta1PodCertificateRequest readNamespacedPodCertificateRequestStatus() - -read status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReadNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterTrustBundle - - - -> V1beta1ClusterTrustBundle replaceClusterTrustBundle(body) - -replace the specified ClusterTrustBundle - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReplaceClusterTrustBundleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceClusterTrustBundleRequest = { - // name of the ClusterTrustBundle - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - signerName: "signerName_example", - trustBundle: "trustBundle_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterTrustBundle(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1ClusterTrustBundle**| | - **name** | [**string**] | name of the ClusterTrustBundle | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1ClusterTrustBundle - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodCertificateRequest - - - -> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequest(body) - -replace the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodCertificateRequest(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedPodCertificateRequestStatus - - - -> V1beta1PodCertificateRequest replaceNamespacedPodCertificateRequestStatus(body) - -replace status of the specified PodCertificateRequest - -### Example - - -```typescript -import { createConfiguration, CertificatesV1beta1Api } from '@kubernetes/client-node'; -import type { CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new CertificatesV1beta1Api(configuration); - -const request: CertificatesV1beta1ApiReplaceNamespacedPodCertificateRequestStatusRequest = { - // name of the PodCertificateRequest - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - maxExpirationSeconds: 1, - nodeName: "nodeName_example", - nodeUID: "nodeUID_example", - pkixPublicKey: 'YQ==', - podName: "podName_example", - podUID: "podUID_example", - proofOfPossession: 'YQ==', - serviceAccountName: "serviceAccountName_example", - serviceAccountUID: "serviceAccountUID_example", - signerName: "signerName_example", - unverifiedUserAnnotations: { - "key": "key_example", - }, - }, - status: { - beginRefreshAt: new Date('1970-01-01T00:00:00.00Z'), - certificateChain: "certificateChain_example", - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - observedGeneration: 1, - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - notAfter: new Date('1970-01-01T00:00:00.00Z'), - notBefore: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedPodCertificateRequestStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1beta1PodCertificateRequest**| | - **name** | [**string**] | name of the PodCertificateRequest | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1beta1PodCertificateRequest - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationApi.md b/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationApi.md deleted file mode 100644 index 02f45f4fa0c..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: RbacAuthorizationApi -title: RbacAuthorizationApi -sidebar_label: RbacAuthorizationApi -sidebar_position: 9 ---- -# RbacAuthorizationApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/security/RbacAuthorizationApi#getAPIGroup) | **GET** /apis/rbac.authorization.k8s.io/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationV1Api.md deleted file mode 100644 index 84755290f3d..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/RbacAuthorizationV1Api.md +++ /dev/null @@ -1,3034 +0,0 @@ ---- -id: RbacAuthorizationV1Api -title: RbacAuthorizationV1Api -sidebar_label: RbacAuthorizationV1Api -sidebar_position: 10 ---- -# RbacAuthorizationV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#createClusterRole) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**createClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#createClusterRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**createNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#createNamespacedRole) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**createNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#createNamespacedRoleBinding) | **POST** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**deleteClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**deleteClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**deleteCollectionClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionClusterRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**deleteCollectionClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionClusterRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**deleteCollectionNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**deleteCollectionNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteCollectionNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**deleteNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteNamespacedRole) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**deleteNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#deleteNamespacedRoleBinding) | **DELETE** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**getAPIResources**](/docs/api-reference/security/RbacAuthorizationV1Api#getAPIResources) | **GET** /apis/rbac.authorization.k8s.io/v1/ | -[**listClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#listClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles | -[**listClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#listClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | -[**listNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#listNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | -[**listNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#listNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | -[**listRoleBindingForAllNamespaces**](/docs/api-reference/security/RbacAuthorizationV1Api#listRoleBindingForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/rolebindings | -[**listRoleForAllNamespaces**](/docs/api-reference/security/RbacAuthorizationV1Api#listRoleForAllNamespaces) | **GET** /apis/rbac.authorization.k8s.io/v1/roles | -[**patchClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#patchClusterRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**patchClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#patchClusterRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**patchNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#patchNamespacedRole) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**patchNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#patchNamespacedRoleBinding) | **PATCH** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**readClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#readClusterRole) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**readClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#readClusterRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**readNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#readNamespacedRole) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**readNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#readNamespacedRoleBinding) | **GET** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | -[**replaceClusterRole**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceClusterRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | -[**replaceClusterRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceClusterRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | -[**replaceNamespacedRole**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceNamespacedRole) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | -[**replaceNamespacedRoleBinding**](/docs/api-reference/security/RbacAuthorizationV1Api#replaceNamespacedRoleBinding) | **PUT** /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | - -### createClusterRole - - - -> V1ClusterRole createClusterRole(body) - -create a ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiCreateClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateClusterRoleRequest = { - - body: { - aggregationRule: { - clusterRoleSelectors: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - ], - }, - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRole**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ClusterRole - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createClusterRoleBinding - - - -> V1ClusterRoleBinding createClusterRoleBinding(body) - -create a ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiCreateClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateClusterRoleBindingRequest = { - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRoleBinding**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedRole - - - -> V1Role createNamespacedRole(body) - -create a Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiCreateNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Role**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Role - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedRoleBinding - - - -> V1RoleBinding createNamespacedRoleBinding(body) - -create a RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RoleBinding**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1RoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteClusterRole - - - -> V1Status deleteClusterRole() - -delete a ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteClusterRoleBinding - - - -> V1Status deleteClusterRoleBinding() - -delete a ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterRole - - - -> V1Status deleteCollectionClusterRole() - -delete collection of ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionClusterRoleBinding - - - -> V1Status deleteCollectionClusterRoleBinding() - -delete collection of ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedRole - - - -> V1Status deleteCollectionNamespacedRole() - -delete collection of Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedRoleBinding - - - -> V1Status deleteCollectionNamespacedRoleBinding() - -delete collection of RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedRole - - - -> V1Status deleteNamespacedRole() - -delete a Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedRoleBinding - - - -> V1Status deleteNamespacedRoleBinding() - -delete a RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterRole - - - -> V1ClusterRoleList listClusterRole() - -list or watch objects of kind ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListClusterRoleRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listClusterRoleBinding - - - -> V1ClusterRoleBindingList listClusterRoleBinding() - -list or watch objects of kind ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListClusterRoleBindingRequest = { - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedRole - - - -> V1RoleList listNamespacedRole() - -list or watch objects of kind Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListNamespacedRoleRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RoleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedRoleBinding - - - -> V1RoleBindingList listNamespacedRoleBinding() - -list or watch objects of kind RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListNamespacedRoleBindingRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RoleBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listRoleBindingForAllNamespaces - - - -> V1RoleBindingList listRoleBindingForAllNamespaces() - -list or watch objects of kind RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRoleBindingForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RoleBindingList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listRoleForAllNamespaces - - - -> V1RoleList listRoleForAllNamespaces() - -list or watch objects of kind Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiListRoleForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiListRoleForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listRoleForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1RoleList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchClusterRole - - - -> V1ClusterRole patchClusterRole(body) - -partially update the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiPatchClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ClusterRole - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchClusterRoleBinding - - - -> V1ClusterRoleBinding patchClusterRoleBinding(body) - -partially update the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiPatchClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedRole - - - -> V1Role patchNamespacedRole(body) - -partially update the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiPatchNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Role - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedRoleBinding - - - -> V1RoleBinding patchNamespacedRoleBinding(body) - -partially update the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1RoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readClusterRole - - - -> V1ClusterRole readClusterRole() - -read the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReadClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ClusterRole - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readClusterRoleBinding - - - -> V1ClusterRoleBinding readClusterRoleBinding() - -read the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReadClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedRole - - - -> V1Role readNamespacedRole() - -read the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReadNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Role - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedRoleBinding - - - -> V1RoleBinding readNamespacedRoleBinding() - -read the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1RoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceClusterRole - - - -> V1ClusterRole replaceClusterRole(body) - -replace the specified ClusterRole - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReplaceClusterRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceClusterRoleRequest = { - // name of the ClusterRole - name: "name_example", - - body: { - aggregationRule: { - clusterRoleSelectors: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - ], - }, - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRole**| | - **name** | [**string**] | name of the ClusterRole | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ClusterRole - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceClusterRoleBinding - - - -> V1ClusterRoleBinding replaceClusterRoleBinding(body) - -replace the specified ClusterRoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest = { - // name of the ClusterRoleBinding - name: "name_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceClusterRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ClusterRoleBinding**| | - **name** | [**string**] | name of the ClusterRoleBinding | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ClusterRoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedRole - - - -> V1Role replaceNamespacedRole(body) - -replace the specified Role - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReplaceNamespacedRoleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceNamespacedRoleRequest = { - // name of the Role - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - rules: [ - { - apiGroups: [ - "apiGroups_example", - ], - nonResourceURLs: [ - "nonResourceURLs_example", - ], - resourceNames: [ - "resourceNames_example", - ], - resources: [ - "resources_example", - ], - verbs: [ - "verbs_example", - ], - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedRole(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Role**| | - **name** | [**string**] | name of the Role | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Role - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedRoleBinding - - - -> V1RoleBinding replaceNamespacedRoleBinding(body) - -replace the specified RoleBinding - -### Example - - -```typescript -import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node'; -import type { RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new RbacAuthorizationV1Api(configuration); - -const request: RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest = { - // name of the RoleBinding - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - roleRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - subjects: [ - { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - ], - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedRoleBinding(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1RoleBinding**| | - **name** | [**string**] | name of the RoleBinding | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1RoleBinding - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/security/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/security/_category_.json deleted file mode 100644 index 45fba4709cc..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/security/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Security", - "position": 4 -} diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsApi.md b/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsApi.md deleted file mode 100644 index ca768916c31..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: AppsApi -title: AppsApi -sidebar_label: AppsApi -sidebar_position: 1 ---- -# AppsApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/workloads/AppsApi#getAPIGroup) | **GET** /apis/apps/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, AppsApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsV1Api.md deleted file mode 100644 index 61a75520691..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/workloads/AppsV1Api.md +++ /dev/null @@ -1,28122 +0,0 @@ ---- -id: AppsV1Api -title: AppsV1Api -sidebar_label: AppsV1Api -sidebar_position: 2 ---- -# AppsV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#createNamespacedControllerRevision) | **POST** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**createNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedDaemonSet) | **POST** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**createNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#createNamespacedDeployment) | **POST** /apis/apps/v1/namespaces/{namespace}/deployments | -[**createNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedReplicaSet) | **POST** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**createNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#createNamespacedStatefulSet) | **POST** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**deleteCollectionNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**deleteCollectionNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**deleteCollectionNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments | -[**deleteCollectionNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**deleteCollectionNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#deleteCollectionNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**deleteNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedControllerRevision) | **DELETE** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**deleteNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedDaemonSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**deleteNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedDeployment) | **DELETE** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**deleteNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedReplicaSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**deleteNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#deleteNamespacedStatefulSet) | **DELETE** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**getAPIResources**](/docs/api-reference/workloads/AppsV1Api#getAPIResources) | **GET** /apis/apps/v1/ | -[**listControllerRevisionForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listControllerRevisionForAllNamespaces) | **GET** /apis/apps/v1/controllerrevisions | -[**listDaemonSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listDaemonSetForAllNamespaces) | **GET** /apis/apps/v1/daemonsets | -[**listDeploymentForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listDeploymentForAllNamespaces) | **GET** /apis/apps/v1/deployments | -[**listNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#listNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions | -[**listNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets | -[**listNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#listNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments | -[**listNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets | -[**listNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#listNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets | -[**listReplicaSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listReplicaSetForAllNamespaces) | **GET** /apis/apps/v1/replicasets | -[**listStatefulSetForAllNamespaces**](/docs/api-reference/workloads/AppsV1Api#listStatefulSetForAllNamespaces) | **GET** /apis/apps/v1/statefulsets | -[**patchNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedControllerRevision) | **PATCH** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**patchNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDaemonSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**patchNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDaemonSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**patchNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeployment) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**patchNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeploymentScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**patchNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedDeploymentStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**patchNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**patchNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**patchNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedReplicaSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**patchNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSet) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**patchNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSetScale) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**patchNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#patchNamespacedStatefulSetStatus) | **PATCH** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | -[**readNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#readNamespacedControllerRevision) | **GET** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**readNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDaemonSet) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**readNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDaemonSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**readNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeployment) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**readNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeploymentScale) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**readNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedDeploymentStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**readNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSet) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**readNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**readNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedReplicaSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**readNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSet) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**readNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSetScale) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**readNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#readNamespacedStatefulSetStatus) | **GET** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | -[**replaceNamespacedControllerRevision**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedControllerRevision) | **PUT** /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} | -[**replaceNamespacedDaemonSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDaemonSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} | -[**replaceNamespacedDaemonSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDaemonSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status | -[**replaceNamespacedDeployment**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeployment) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name} | -[**replaceNamespacedDeploymentScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeploymentScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale | -[**replaceNamespacedDeploymentStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedDeploymentStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status | -[**replaceNamespacedReplicaSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name} | -[**replaceNamespacedReplicaSetScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale | -[**replaceNamespacedReplicaSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedReplicaSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status | -[**replaceNamespacedStatefulSet**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSet) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} | -[**replaceNamespacedStatefulSetScale**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSetScale) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale | -[**replaceNamespacedStatefulSetStatus**](/docs/api-reference/workloads/AppsV1Api#replaceNamespacedStatefulSetStatus) | **PUT** /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status | - -### createNamespacedControllerRevision - - - -> V1ControllerRevision createNamespacedControllerRevision(body) - -create a ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: {}, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - revision: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ControllerRevision**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ControllerRevision - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedDaemonSet - - - -> V1DaemonSet createNamespacedDaemonSet(body) - -create a DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedDeployment - - - -> V1Deployment createNamespacedDeployment(body) - -create a Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedReplicaSet - - - -> V1ReplicaSet createNamespacedReplicaSet(body) - -create a ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedStatefulSet - - - -> V1StatefulSet createNamespacedStatefulSet(body) - -create a StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiCreateNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiCreateNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedControllerRevision - - - -> V1Status deleteCollectionNamespacedControllerRevision() - -delete collection of ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedDaemonSet - - - -> V1Status deleteCollectionNamespacedDaemonSet() - -delete collection of DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedDeployment - - - -> V1Status deleteCollectionNamespacedDeployment() - -delete collection of Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedReplicaSet - - - -> V1Status deleteCollectionNamespacedReplicaSet() - -delete collection of ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedStatefulSet - - - -> V1Status deleteCollectionNamespacedStatefulSet() - -delete collection of StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteCollectionNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedControllerRevision - - - -> V1Status deleteNamespacedControllerRevision() - -delete a ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedDaemonSet - - - -> V1Status deleteNamespacedDaemonSet() - -delete a DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedDeployment - - - -> V1Status deleteNamespacedDeployment() - -delete a Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedReplicaSet - - - -> V1Status deleteNamespacedReplicaSet() - -delete a ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedStatefulSet - - - -> V1Status deleteNamespacedStatefulSet() - -delete a StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiDeleteNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiDeleteNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listControllerRevisionForAllNamespaces - - - -> V1ControllerRevisionList listControllerRevisionForAllNamespaces() - -list or watch objects of kind ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListControllerRevisionForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListControllerRevisionForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listControllerRevisionForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ControllerRevisionList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDaemonSetForAllNamespaces - - - -> V1DaemonSetList listDaemonSetForAllNamespaces() - -list or watch objects of kind DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListDaemonSetForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListDaemonSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDaemonSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DaemonSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listDeploymentForAllNamespaces - - - -> V1DeploymentList listDeploymentForAllNamespaces() - -list or watch objects of kind Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListDeploymentForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListDeploymentForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listDeploymentForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DeploymentList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedControllerRevision - - - -> V1ControllerRevisionList listNamespacedControllerRevision() - -list or watch objects of kind ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedControllerRevisionRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ControllerRevisionList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedDaemonSet - - - -> V1DaemonSetList listNamespacedDaemonSet() - -list or watch objects of kind DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedDaemonSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DaemonSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedDeployment - - - -> V1DeploymentList listNamespacedDeployment() - -list or watch objects of kind Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedDeploymentRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1DeploymentList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedReplicaSet - - - -> V1ReplicaSetList listNamespacedReplicaSet() - -list or watch objects of kind ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedReplicaSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ReplicaSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedStatefulSet - - - -> V1StatefulSetList listNamespacedStatefulSet() - -list or watch objects of kind StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListNamespacedStatefulSetRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1StatefulSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listReplicaSetForAllNamespaces - - - -> V1ReplicaSetList listReplicaSetForAllNamespaces() - -list or watch objects of kind ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListReplicaSetForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListReplicaSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listReplicaSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1ReplicaSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listStatefulSetForAllNamespaces - - - -> V1StatefulSetList listStatefulSetForAllNamespaces() - -list or watch objects of kind StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiListStatefulSetForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiListStatefulSetForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listStatefulSetForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1StatefulSetList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedControllerRevision - - - -> V1ControllerRevision patchNamespacedControllerRevision(body) - -partially update the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ControllerRevision - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDaemonSet - - - -> V1DaemonSet patchNamespacedDaemonSet(body) - -partially update the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDaemonSetStatus - - - -> V1DaemonSet patchNamespacedDaemonSetStatus(body) - -partially update status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDeployment - - - -> V1Deployment patchNamespacedDeployment(body) - -partially update the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDeploymentScale - - - -> V1Scale patchNamespacedDeploymentScale(body) - -partially update scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedDeploymentStatus - - - -> V1Deployment patchNamespacedDeploymentStatus(body) - -partially update status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicaSet - - - -> V1ReplicaSet patchNamespacedReplicaSet(body) - -partially update the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicaSetScale - - - -> V1Scale patchNamespacedReplicaSetScale(body) - -partially update scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedReplicaSetStatus - - - -> V1ReplicaSet patchNamespacedReplicaSetStatus(body) - -partially update status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedStatefulSet - - - -> V1StatefulSet patchNamespacedStatefulSet(body) - -partially update the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedStatefulSetScale - - - -> V1Scale patchNamespacedStatefulSetScale(body) - -partially update scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedStatefulSetStatus - - - -> V1StatefulSet patchNamespacedStatefulSetStatus(body) - -partially update status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiPatchNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiPatchNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedControllerRevision - - - -> V1ControllerRevision readNamespacedControllerRevision() - -read the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ControllerRevision - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDaemonSet - - - -> V1DaemonSet readNamespacedDaemonSet() - -read the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDaemonSetStatus - - - -> V1DaemonSet readNamespacedDaemonSetStatus() - -read status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDeployment - - - -> V1Deployment readNamespacedDeployment() - -read the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDeploymentScale - - - -> V1Scale readNamespacedDeploymentScale() - -read scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedDeploymentStatus - - - -> V1Deployment readNamespacedDeploymentStatus() - -read status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicaSet - - - -> V1ReplicaSet readNamespacedReplicaSet() - -read the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicaSetScale - - - -> V1Scale readNamespacedReplicaSetScale() - -read scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedReplicaSetStatus - - - -> V1ReplicaSet readNamespacedReplicaSetStatus() - -read status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedStatefulSet - - - -> V1StatefulSet readNamespacedStatefulSet() - -read the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedStatefulSetScale - - - -> V1Scale readNamespacedStatefulSetScale() - -read scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedStatefulSetStatus - - - -> V1StatefulSet readNamespacedStatefulSetStatus() - -read status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReadNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReadNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedControllerRevision - - - -> V1ControllerRevision replaceNamespacedControllerRevision(body) - -replace the specified ControllerRevision - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedControllerRevisionRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedControllerRevisionRequest = { - // name of the ControllerRevision - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - data: {}, - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - revision: 1, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedControllerRevision(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ControllerRevision**| | - **name** | [**string**] | name of the ControllerRevision | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ControllerRevision - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDaemonSet - - - -> V1DaemonSet replaceNamespacedDaemonSet(body) - -replace the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDaemonSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDaemonSetRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDaemonSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDaemonSetStatus - - - -> V1DaemonSet replaceNamespacedDaemonSetStatus(body) - -replace status of the specified DaemonSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDaemonSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDaemonSetStatusRequest = { - // name of the DaemonSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - }, - status: { - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentNumberScheduled: 1, - desiredNumberScheduled: 1, - numberAvailable: 1, - numberMisscheduled: 1, - numberReady: 1, - numberUnavailable: 1, - observedGeneration: 1, - updatedNumberScheduled: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDaemonSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DaemonSet**| | - **name** | [**string**] | name of the DaemonSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1DaemonSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDeployment - - - -> V1Deployment replaceNamespacedDeployment(body) - -replace the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDeploymentRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeployment(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDeploymentScale - - - -> V1Scale replaceNamespacedDeploymentScale(body) - -replace scale of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDeploymentScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeploymentScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedDeploymentStatus - - - -> V1Deployment replaceNamespacedDeploymentStatus(body) - -replace status of the specified Deployment - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedDeploymentStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedDeploymentStatusRequest = { - // name of the Deployment - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - paused: true, - progressDeadlineSeconds: 1, - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - strategy: { - rollingUpdate: { - maxSurge: "maxSurge_example", - maxUnavailable: "maxUnavailable_example", - }, - type: "type_example", - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - lastUpdateTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - unavailableReplicas: 1, - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedDeploymentStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Deployment**| | - **name** | [**string**] | name of the Deployment | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Deployment - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicaSet - - - -> V1ReplicaSet replaceNamespacedReplicaSet(body) - -replace the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedReplicaSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicaSetScale - - - -> V1Scale replaceNamespacedReplicaSetScale(body) - -replace scale of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedReplicaSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedReplicaSetStatus - - - -> V1ReplicaSet replaceNamespacedReplicaSetStatus(body) - -replace status of the specified ReplicaSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedReplicaSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedReplicaSetStatusRequest = { - // name of the ReplicaSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - replicas: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - }, - status: { - availableReplicas: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - fullyLabeledReplicas: 1, - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - terminatingReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedReplicaSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1ReplicaSet**| | - **name** | [**string**] | name of the ReplicaSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1ReplicaSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedStatefulSet - - - -> V1StatefulSet replaceNamespacedStatefulSet(body) - -replace the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedStatefulSetRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSet(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedStatefulSetScale - - - -> V1Scale replaceNamespacedStatefulSetScale(body) - -replace scale of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedStatefulSetScaleRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetScaleRequest = { - // name of the Scale - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - replicas: 1, - }, - status: { - replicas: 1, - selector: "selector_example", - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSetScale(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Scale**| | - **name** | [**string**] | name of the Scale | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Scale - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedStatefulSetStatus - - - -> V1StatefulSet replaceNamespacedStatefulSetStatus(body) - -replace status of the specified StatefulSet - -### Example - - -```typescript -import { createConfiguration, AppsV1Api } from '@kubernetes/client-node'; -import type { AppsV1ApiReplaceNamespacedStatefulSetStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new AppsV1Api(configuration); - -const request: AppsV1ApiReplaceNamespacedStatefulSetStatusRequest = { - // name of the StatefulSet - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - minReadySeconds: 1, - ordinals: { - start: 1, - }, - persistentVolumeClaimRetentionPolicy: { - whenDeleted: "whenDeleted_example", - whenScaled: "whenScaled_example", - }, - podManagementPolicy: "podManagementPolicy_example", - replicas: 1, - revisionHistoryLimit: 1, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - serviceName: "serviceName_example", - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - updateStrategy: { - rollingUpdate: { - maxUnavailable: "maxUnavailable_example", - partition: 1, - }, - type: "type_example", - }, - volumeClaimTemplates: [ - { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - status: { - accessModes: [ - "accessModes_example", - ], - allocatedResourceStatuses: { - "key": "key_example", - }, - allocatedResources: { - "key": "key_example", - }, - capacity: { - "key": "key_example", - }, - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentVolumeAttributesClassName: "currentVolumeAttributesClassName_example", - modifyVolumeStatus: { - status: "status_example", - targetVolumeAttributesClassName: "targetVolumeAttributesClassName_example", - }, - phase: "phase_example", - }, - }, - ], - }, - status: { - availableReplicas: 1, - collisionCount: 1, - conditions: [ - { - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - currentReplicas: 1, - currentRevision: "currentRevision_example", - observedGeneration: 1, - readyReplicas: 1, - replicas: 1, - updateRevision: "updateRevision_example", - updatedReplicas: 1, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedStatefulSetStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1StatefulSet**| | - **name** | [**string**] | name of the StatefulSet | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1StatefulSet - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchApi.md b/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchApi.md deleted file mode 100644 index 6eecc6c2da6..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchApi.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: BatchApi -title: BatchApi -sidebar_label: BatchApi -sidebar_position: 3 ---- -# BatchApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getAPIGroup**](/docs/api-reference/workloads/BatchApi#getAPIGroup) | **GET** /apis/batch/ | - -### getAPIGroup - - - -> V1APIGroup getAPIGroup() - -get information of a group - -### Example - - -```typescript -import { createConfiguration, BatchApi } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchApi(configuration); - -const request = {}; - -const data = await apiInstance.getAPIGroup(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIGroup - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchV1Api.md b/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchV1Api.md deleted file mode 100644 index 3a672c79b93..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/workloads/BatchV1Api.md +++ /dev/null @@ -1,13489 +0,0 @@ ---- -id: BatchV1Api -title: BatchV1Api -sidebar_label: BatchV1Api -sidebar_position: 4 ---- -# BatchV1Api - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#createNamespacedCronJob) | **POST** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**createNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#createNamespacedJob) | **POST** /apis/batch/v1/namespaces/{namespace}/jobs | -[**deleteCollectionNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#deleteCollectionNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**deleteCollectionNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#deleteCollectionNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs | -[**deleteNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#deleteNamespacedCronJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**deleteNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#deleteNamespacedJob) | **DELETE** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**getAPIResources**](/docs/api-reference/workloads/BatchV1Api#getAPIResources) | **GET** /apis/batch/v1/ | -[**listCronJobForAllNamespaces**](/docs/api-reference/workloads/BatchV1Api#listCronJobForAllNamespaces) | **GET** /apis/batch/v1/cronjobs | -[**listJobForAllNamespaces**](/docs/api-reference/workloads/BatchV1Api#listJobForAllNamespaces) | **GET** /apis/batch/v1/jobs | -[**listNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#listNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs | -[**listNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#listNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs | -[**patchNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedCronJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**patchNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedCronJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**patchNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedJob) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**patchNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#patchNamespacedJobStatus) | **PATCH** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | -[**readNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#readNamespacedCronJob) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**readNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#readNamespacedCronJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**readNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#readNamespacedJob) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**readNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#readNamespacedJobStatus) | **GET** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | -[**replaceNamespacedCronJob**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedCronJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} | -[**replaceNamespacedCronJobStatus**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedCronJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status | -[**replaceNamespacedJob**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedJob) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name} | -[**replaceNamespacedJobStatus**](/docs/api-reference/workloads/BatchV1Api#replaceNamespacedJobStatus) | **PUT** /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status | - -### createNamespacedCronJob - - - -> V1CronJob createNamespacedCronJob(body) - -create a CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiCreateNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiCreateNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### createNamespacedJob - - - -> V1Job createNamespacedJob(body) - -create a Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiCreateNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiCreateNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.createNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedCronJob - - - -> V1Status deleteCollectionNamespacedCronJob() - -delete collection of CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiDeleteCollectionNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteCollectionNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteCollectionNamespacedJob - - - -> V1Status deleteCollectionNamespacedJob() - -delete collection of Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiDeleteCollectionNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteCollectionNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteCollectionNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### deleteNamespacedCronJob - - - -> V1Status deleteNamespacedCronJob() - -delete a CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiDeleteNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### deleteNamespacedJob - - - -> V1Status deleteNamespacedJob() - -delete a Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiDeleteNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiDeleteNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional) - gracePeriodSeconds: 1, - // if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it (optional) - ignoreStoreReadErrorWithClusterBreakingPotential: true, - // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional) - orphanDependents: true, - // Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. (optional) - propagationPolicy: "propagationPolicy_example", - - body: { - apiVersion: "apiVersion_example", - dryRun: [ - "dryRun_example", - ], - gracePeriodSeconds: 1, - ignoreStoreReadErrorWithClusterBreakingPotential: true, - kind: "kind_example", - orphanDependents: true, - preconditions: { - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - propagationPolicy: "propagationPolicy_example", - }, -}; - -const data = await apiInstance.deleteNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1DeleteOptions**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **gracePeriodSeconds** | [**number**] | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | (optional) defaults to undefined - **ignoreStoreReadErrorWithClusterBreakingPotential** | [**boolean**] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it | (optional) defaults to undefined - **orphanDependents** | [**boolean**] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. | (optional) defaults to undefined - **propagationPolicy** | [**string**] | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents in the foreground. | (optional) defaults to undefined - -### Return type - -V1Status - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**202** | Accepted | - | -**401** | Unauthorized | - | - -### getAPIResources - - - -> V1APIResourceList getAPIResources() - -get available resources - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request = {}; - -const data = await apiInstance.getAPIResources(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -This endpoint does not need any parameter. - -### Return type - -V1APIResourceList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listCronJobForAllNamespaces - - - -> V1CronJobList listCronJobForAllNamespaces() - -list or watch objects of kind CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiListCronJobForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListCronJobForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listCronJobForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CronJobList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listJobForAllNamespaces - - - -> V1JobList listJobForAllNamespaces() - -list or watch objects of kind Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiListJobForAllNamespacesRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListJobForAllNamespacesRequest = { - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listJobForAllNamespaces(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1JobList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedCronJob - - - -> V1CronJobList listNamespacedCronJob() - -list or watch objects of kind CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiListNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListNamespacedCronJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1CronJobList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### listNamespacedJob - - - -> V1JobList listNamespacedJob() - -list or watch objects of kind Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiListNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiListNamespacedJobRequest = { - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional) - allowWatchBookmarks: true, - // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional) - _continue: "continue_example", - // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional) - fieldSelector: "fieldSelector_example", - // A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional) - labelSelector: "labelSelector_example", - // limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional) - limit: 1, - // resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersion: "resourceVersion_example", - // resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional) - resourceVersionMatch: "resourceVersionMatch_example", - // `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional) - sendInitialEvents: true, - // Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional) - timeoutSeconds: 1, - // Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional) - watch: true, -}; - -const data = await apiInstance.listNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **allowWatchBookmarks** | [**boolean**] | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | (optional) defaults to undefined - **_continue** | [**string**] | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | (optional) defaults to undefined - **fieldSelector** | [**string**] | A selector to restrict the list of returned objects by their fields. Defaults to everything. | (optional) defaults to undefined - **labelSelector** | [**string**] | A selector to restrict the list of returned objects by their labels. Defaults to everything. | (optional) defaults to undefined - **limit** | [**number**] | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | (optional) defaults to undefined - **resourceVersion** | [**string**] | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **resourceVersionMatch** | [**string**] | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | (optional) defaults to undefined - **sendInitialEvents** | [**boolean**] | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. | (optional) defaults to undefined - **timeoutSeconds** | [**number**] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | (optional) defaults to undefined - **watch** | [**boolean**] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | (optional) defaults to undefined - -### Return type - -V1JobList - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### patchNamespacedCronJob - - - -> V1CronJob patchNamespacedCronJob(body) - -partially update the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiPatchNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedCronJobStatus - - - -> V1CronJob patchNamespacedCronJobStatus(body) - -partially update status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiPatchNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedJob - - - -> V1Job patchNamespacedJob(body) - -partially update the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiPatchNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### patchNamespacedJobStatus - - - -> V1Job patchNamespacedJobStatus(body) - -partially update status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiPatchNamespacedJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiPatchNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: {}, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", - // Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. (optional) - force: true, -}; - -const data = await apiInstance.patchNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **any**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - **force** | [**boolean**] | Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### readNamespacedCronJob - - - -> V1CronJob readNamespacedCronJob() - -read the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReadNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedCronJobStatus - - - -> V1CronJob readNamespacedCronJobStatus() - -read status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReadNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedJob - - - -> V1Job readNamespacedJob() - -read the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReadNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### readNamespacedJobStatus - - - -> V1Job readNamespacedJobStatus() - -read status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReadNamespacedJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReadNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", -}; - -const data = await apiInstance.readNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -### replaceNamespacedCronJob - - - -> V1CronJob replaceNamespacedCronJob(body) - -replace the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReplaceNamespacedCronJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedCronJobRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCronJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedCronJobStatus - - - -> V1CronJob replaceNamespacedCronJobStatus(body) - -replace status of the specified CronJob - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReplaceNamespacedCronJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedCronJobStatusRequest = { - // name of the CronJob - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - concurrencyPolicy: "concurrencyPolicy_example", - failedJobsHistoryLimit: 1, - jobTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - }, - schedule: "schedule_example", - startingDeadlineSeconds: 1, - successfulJobsHistoryLimit: 1, - suspend: true, - timeZone: "timeZone_example", - }, - status: { - active: [ - { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - resourceVersion: "resourceVersion_example", - uid: "uid_example", - }, - ], - lastScheduleTime: new Date('1970-01-01T00:00:00.00Z'), - lastSuccessfulTime: new Date('1970-01-01T00:00:00.00Z'), - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedCronJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1CronJob**| | - **name** | [**string**] | name of the CronJob | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1CronJob - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedJob - - - -> V1Job replaceNamespacedJob(body) - -replace the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReplaceNamespacedJobRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedJobRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedJob(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - -### replaceNamespacedJobStatus - - - -> V1Job replaceNamespacedJobStatus(body) - -replace status of the specified Job - -### Example - - -```typescript -import { createConfiguration, BatchV1Api } from '@kubernetes/client-node'; -import type { BatchV1ApiReplaceNamespacedJobStatusRequest } from '@kubernetes/client-node'; - -const configuration = createConfiguration(); -const apiInstance = new BatchV1Api(configuration); - -const request: BatchV1ApiReplaceNamespacedJobStatusRequest = { - // name of the Job - name: "name_example", - // object name and auth scope, such as for teams and projects - namespace: "namespace_example", - - body: { - apiVersion: "apiVersion_example", - kind: "kind_example", - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - backoffLimit: 1, - backoffLimitPerIndex: 1, - completionMode: "completionMode_example", - completions: 1, - managedBy: "managedBy_example", - manualSelector: true, - maxFailedIndexes: 1, - parallelism: 1, - podFailurePolicy: { - rules: [ - { - action: "action_example", - onExitCodes: { - containerName: "containerName_example", - operator: "operator_example", - values: [ - 1, - ], - }, - onPodConditions: [ - { - status: "status_example", - type: "type_example", - }, - ], - }, - ], - }, - podReplacementPolicy: "podReplacementPolicy_example", - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - successPolicy: { - rules: [ - { - succeededCount: 1, - succeededIndexes: "succeededIndexes_example", - }, - ], - }, - suspend: true, - template: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - activeDeadlineSeconds: 1, - affinity: { - nodeAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - preference: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: { - nodeSelectorTerms: [ - { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchFields: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - }, - ], - }, - }, - podAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - podAntiAffinity: { - preferredDuringSchedulingIgnoredDuringExecution: [ - { - podAffinityTerm: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - weight: 1, - }, - ], - requiredDuringSchedulingIgnoredDuringExecution: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - mismatchLabelKeys: [ - "mismatchLabelKeys_example", - ], - namespaceSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - namespaces: [ - "namespaces_example", - ], - topologyKey: "topologyKey_example", - }, - ], - }, - }, - automountServiceAccountToken: true, - containers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - dnsConfig: { - nameservers: [ - "nameservers_example", - ], - options: [ - { - name: "name_example", - value: "value_example", - }, - ], - searches: [ - "searches_example", - ], - }, - dnsPolicy: "dnsPolicy_example", - enableServiceLinks: true, - ephemeralContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - targetContainerName: "targetContainerName_example", - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - hostAliases: [ - { - hostnames: [ - "hostnames_example", - ], - ip: "ip_example", - }, - ], - hostIPC: true, - hostNetwork: true, - hostPID: true, - hostUsers: true, - hostname: "hostname_example", - hostnameOverride: "hostnameOverride_example", - imagePullSecrets: [ - { - name: "name_example", - }, - ], - initContainers: [ - { - args: [ - "args_example", - ], - command: [ - "command_example", - ], - env: [ - { - name: "name_example", - value: "value_example", - valueFrom: { - configMapKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - fileKeyRef: { - key: "key_example", - optional: true, - path: "path_example", - volumeName: "volumeName_example", - }, - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - secretKeyRef: { - key: "key_example", - name: "name_example", - optional: true, - }, - }, - }, - ], - envFrom: [ - { - configMapRef: { - name: "name_example", - optional: true, - }, - prefix: "prefix_example", - secretRef: { - name: "name_example", - optional: true, - }, - }, - ], - image: "image_example", - imagePullPolicy: "imagePullPolicy_example", - lifecycle: { - postStart: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - preStop: { - exec: { - command: [ - "command_example", - ], - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - sleep: { - seconds: 1, - }, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - }, - stopSignal: "stopSignal_example", - }, - livenessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - name: "name_example", - ports: [ - { - containerPort: 1, - hostIP: "hostIP_example", - hostPort: 1, - name: "name_example", - protocol: "protocol_example", - }, - ], - readinessProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - resizePolicy: [ - { - resourceName: "resourceName_example", - restartPolicy: "restartPolicy_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - restartPolicyRules: [ - { - action: "action_example", - exitCodes: { - operator: "operator_example", - values: [ - 1, - ], - }, - }, - ], - securityContext: { - allowPrivilegeEscalation: true, - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - capabilities: { - add: [ - "add_example", - ], - drop: [ - "drop_example", - ], - }, - privileged: true, - procMount: "procMount_example", - readOnlyRootFilesystem: true, - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - startupProbe: { - exec: { - command: [ - "command_example", - ], - }, - failureThreshold: 1, - grpc: { - port: 1, - service: "service_example", - }, - httpGet: { - host: "host_example", - httpHeaders: [ - { - name: "name_example", - value: "value_example", - }, - ], - path: "path_example", - port: "port_example", - scheme: "scheme_example", - }, - initialDelaySeconds: 1, - periodSeconds: 1, - successThreshold: 1, - tcpSocket: { - host: "host_example", - port: "port_example", - }, - terminationGracePeriodSeconds: 1, - timeoutSeconds: 1, - }, - stdin: true, - stdinOnce: true, - terminationMessagePath: "terminationMessagePath_example", - terminationMessagePolicy: "terminationMessagePolicy_example", - tty: true, - volumeDevices: [ - { - devicePath: "devicePath_example", - name: "name_example", - }, - ], - volumeMounts: [ - { - mountPath: "mountPath_example", - mountPropagation: "mountPropagation_example", - name: "name_example", - readOnly: true, - recursiveReadOnly: "recursiveReadOnly_example", - subPath: "subPath_example", - subPathExpr: "subPathExpr_example", - }, - ], - workingDir: "workingDir_example", - }, - ], - nodeName: "nodeName_example", - nodeSelector: { - "key": "key_example", - }, - os: { - name: "name_example", - }, - overhead: { - "key": "key_example", - }, - preemptionPolicy: "preemptionPolicy_example", - priority: 1, - priorityClassName: "priorityClassName_example", - readinessGates: [ - { - conditionType: "conditionType_example", - }, - ], - resourceClaims: [ - { - name: "name_example", - resourceClaimName: "resourceClaimName_example", - resourceClaimTemplateName: "resourceClaimTemplateName_example", - }, - ], - resources: { - claims: [ - { - name: "name_example", - request: "request_example", - }, - ], - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - restartPolicy: "restartPolicy_example", - runtimeClassName: "runtimeClassName_example", - schedulerName: "schedulerName_example", - schedulingGates: [ - { - name: "name_example", - }, - ], - securityContext: { - appArmorProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - fsGroup: 1, - fsGroupChangePolicy: "fsGroupChangePolicy_example", - runAsGroup: 1, - runAsNonRoot: true, - runAsUser: 1, - seLinuxChangePolicy: "seLinuxChangePolicy_example", - seLinuxOptions: { - level: "level_example", - role: "role_example", - type: "type_example", - user: "user_example", - }, - seccompProfile: { - localhostProfile: "localhostProfile_example", - type: "type_example", - }, - supplementalGroups: [ - 1, - ], - supplementalGroupsPolicy: "supplementalGroupsPolicy_example", - sysctls: [ - { - name: "name_example", - value: "value_example", - }, - ], - windowsOptions: { - gmsaCredentialSpec: "gmsaCredentialSpec_example", - gmsaCredentialSpecName: "gmsaCredentialSpecName_example", - hostProcess: true, - runAsUserName: "runAsUserName_example", - }, - }, - serviceAccount: "serviceAccount_example", - serviceAccountName: "serviceAccountName_example", - setHostnameAsFQDN: true, - shareProcessNamespace: true, - subdomain: "subdomain_example", - terminationGracePeriodSeconds: 1, - tolerations: [ - { - effect: "effect_example", - key: "key_example", - operator: "operator_example", - tolerationSeconds: 1, - value: "value_example", - }, - ], - topologySpreadConstraints: [ - { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - matchLabelKeys: [ - "matchLabelKeys_example", - ], - maxSkew: 1, - minDomains: 1, - nodeAffinityPolicy: "nodeAffinityPolicy_example", - nodeTaintsPolicy: "nodeTaintsPolicy_example", - topologyKey: "topologyKey_example", - whenUnsatisfiable: "whenUnsatisfiable_example", - }, - ], - volumes: [ - { - awsElasticBlockStore: { - fsType: "fsType_example", - partition: 1, - readOnly: true, - volumeID: "volumeID_example", - }, - azureDisk: { - cachingMode: "cachingMode_example", - diskName: "diskName_example", - diskURI: "diskURI_example", - fsType: "fsType_example", - kind: "kind_example", - readOnly: true, - }, - azureFile: { - readOnly: true, - secretName: "secretName_example", - shareName: "shareName_example", - }, - cephfs: { - monitors: [ - "monitors_example", - ], - path: "path_example", - readOnly: true, - secretFile: "secretFile_example", - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - cinder: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeID: "volumeID_example", - }, - configMap: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - csi: { - driver: "driver_example", - fsType: "fsType_example", - nodePublishSecretRef: { - name: "name_example", - }, - readOnly: true, - volumeAttributes: { - "key": "key_example", - }, - }, - downwardAPI: { - defaultMode: 1, - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - emptyDir: { - medium: "medium_example", - sizeLimit: "sizeLimit_example", - }, - ephemeral: { - volumeClaimTemplate: { - metadata: { - annotations: { - "key": "key_example", - }, - creationTimestamp: new Date('1970-01-01T00:00:00.00Z'), - deletionGracePeriodSeconds: 1, - deletionTimestamp: new Date('1970-01-01T00:00:00.00Z'), - finalizers: [ - "finalizers_example", - ], - generateName: "generateName_example", - generation: 1, - labels: { - "key": "key_example", - }, - managedFields: [ - { - apiVersion: "apiVersion_example", - fieldsType: "fieldsType_example", - fieldsV1: {}, - manager: "manager_example", - operation: "operation_example", - subresource: "subresource_example", - time: new Date('1970-01-01T00:00:00.00Z'), - }, - ], - name: "name_example", - namespace: "namespace_example", - ownerReferences: [ - { - apiVersion: "apiVersion_example", - blockOwnerDeletion: true, - controller: true, - kind: "kind_example", - name: "name_example", - uid: "uid_example", - }, - ], - resourceVersion: "resourceVersion_example", - selfLink: "selfLink_example", - uid: "uid_example", - }, - spec: { - accessModes: [ - "accessModes_example", - ], - dataSource: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - }, - dataSourceRef: { - apiGroup: "apiGroup_example", - kind: "kind_example", - name: "name_example", - namespace: "namespace_example", - }, - resources: { - limits: { - "key": "key_example", - }, - requests: { - "key": "key_example", - }, - }, - selector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - storageClassName: "storageClassName_example", - volumeAttributesClassName: "volumeAttributesClassName_example", - volumeMode: "volumeMode_example", - volumeName: "volumeName_example", - }, - }, - }, - fc: { - fsType: "fsType_example", - lun: 1, - readOnly: true, - targetWWNs: [ - "targetWWNs_example", - ], - wwids: [ - "wwids_example", - ], - }, - flexVolume: { - driver: "driver_example", - fsType: "fsType_example", - options: { - "key": "key_example", - }, - readOnly: true, - secretRef: { - name: "name_example", - }, - }, - flocker: { - datasetName: "datasetName_example", - datasetUUID: "datasetUUID_example", - }, - gcePersistentDisk: { - fsType: "fsType_example", - partition: 1, - pdName: "pdName_example", - readOnly: true, - }, - gitRepo: { - directory: "directory_example", - repository: "repository_example", - revision: "revision_example", - }, - glusterfs: { - endpoints: "endpoints_example", - path: "path_example", - readOnly: true, - }, - hostPath: { - path: "path_example", - type: "type_example", - }, - image: { - pullPolicy: "pullPolicy_example", - reference: "reference_example", - }, - iscsi: { - chapAuthDiscovery: true, - chapAuthSession: true, - fsType: "fsType_example", - initiatorName: "initiatorName_example", - iqn: "iqn_example", - iscsiInterface: "iscsiInterface_example", - lun: 1, - portals: [ - "portals_example", - ], - readOnly: true, - secretRef: { - name: "name_example", - }, - targetPortal: "targetPortal_example", - }, - name: "name_example", - nfs: { - path: "path_example", - readOnly: true, - server: "server_example", - }, - persistentVolumeClaim: { - claimName: "claimName_example", - readOnly: true, - }, - photonPersistentDisk: { - fsType: "fsType_example", - pdID: "pdID_example", - }, - portworxVolume: { - fsType: "fsType_example", - readOnly: true, - volumeID: "volumeID_example", - }, - projected: { - defaultMode: 1, - sources: [ - { - clusterTrustBundle: { - labelSelector: { - matchExpressions: [ - { - key: "key_example", - operator: "operator_example", - values: [ - "values_example", - ], - }, - ], - matchLabels: { - "key": "key_example", - }, - }, - name: "name_example", - optional: true, - path: "path_example", - signerName: "signerName_example", - }, - configMap: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - downwardAPI: { - items: [ - { - fieldRef: { - apiVersion: "apiVersion_example", - fieldPath: "fieldPath_example", - }, - mode: 1, - path: "path_example", - resourceFieldRef: { - containerName: "containerName_example", - divisor: "divisor_example", - resource: "resource_example", - }, - }, - ], - }, - podCertificate: { - certificateChainPath: "certificateChainPath_example", - credentialBundlePath: "credentialBundlePath_example", - keyPath: "keyPath_example", - keyType: "keyType_example", - maxExpirationSeconds: 1, - signerName: "signerName_example", - userAnnotations: { - "key": "key_example", - }, - }, - secret: { - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - name: "name_example", - optional: true, - }, - serviceAccountToken: { - audience: "audience_example", - expirationSeconds: 1, - path: "path_example", - }, - }, - ], - }, - quobyte: { - group: "group_example", - readOnly: true, - registry: "registry_example", - tenant: "tenant_example", - user: "user_example", - volume: "volume_example", - }, - rbd: { - fsType: "fsType_example", - image: "image_example", - keyring: "keyring_example", - monitors: [ - "monitors_example", - ], - pool: "pool_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - user: "user_example", - }, - scaleIO: { - fsType: "fsType_example", - gateway: "gateway_example", - protectionDomain: "protectionDomain_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - sslEnabled: true, - storageMode: "storageMode_example", - storagePool: "storagePool_example", - system: "system_example", - volumeName: "volumeName_example", - }, - secret: { - defaultMode: 1, - items: [ - { - key: "key_example", - mode: 1, - path: "path_example", - }, - ], - optional: true, - secretName: "secretName_example", - }, - storageos: { - fsType: "fsType_example", - readOnly: true, - secretRef: { - name: "name_example", - }, - volumeName: "volumeName_example", - volumeNamespace: "volumeNamespace_example", - }, - vsphereVolume: { - fsType: "fsType_example", - storagePolicyID: "storagePolicyID_example", - storagePolicyName: "storagePolicyName_example", - volumePath: "volumePath_example", - }, - }, - ], - workloadRef: { - name: "name_example", - podGroup: "podGroup_example", - podGroupReplicaKey: "podGroupReplicaKey_example", - }, - }, - }, - ttlSecondsAfterFinished: 1, - }, - status: { - active: 1, - completedIndexes: "completedIndexes_example", - completionTime: new Date('1970-01-01T00:00:00.00Z'), - conditions: [ - { - lastProbeTime: new Date('1970-01-01T00:00:00.00Z'), - lastTransitionTime: new Date('1970-01-01T00:00:00.00Z'), - message: "message_example", - reason: "reason_example", - status: "status_example", - type: "type_example", - }, - ], - failed: 1, - failedIndexes: "failedIndexes_example", - ready: 1, - startTime: new Date('1970-01-01T00:00:00.00Z'), - succeeded: 1, - terminating: 1, - uncountedTerminatedPods: { - failed: [ - "failed_example", - ], - succeeded: [ - "succeeded_example", - ], - }, - }, - }, - // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional) - pretty: "pretty_example", - // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional) - dryRun: "dryRun_example", - // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional) - fieldManager: "fieldManager_example", - // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) - fieldValidation: "fieldValidation_example", -}; - -const data = await apiInstance.replaceNamespacedJobStatus(request); -console.log('API called successfully. Returned data:', data); -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **V1Job**| | - **name** | [**string**] | name of the Job | defaults to undefined - **namespace** | [**string**] | object name and auth scope, such as for teams and projects | defaults to undefined - **pretty** | [**string**] | If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | (optional) defaults to undefined - **dryRun** | [**string**] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | (optional) defaults to undefined - **fieldManager** | [**string**] | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | (optional) defaults to undefined - **fieldValidation** | [**string**] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. | (optional) defaults to undefined - -### Return type - -V1Job - -### Authorization - - -[BearerToken](#authorization) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**201** | Created | - | -**401** | Unauthorized | - | - diff --git a/website/versioned_docs/version-2.0.0/api-reference/workloads/_category_.json b/website/versioned_docs/version-2.0.0/api-reference/workloads/_category_.json deleted file mode 100644 index 6f2c7368745..00000000000 --- a/website/versioned_docs/version-2.0.0/api-reference/workloads/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Workloads", - "position": 2 -} diff --git a/website/versioned_docs/version-2.0.0/intro.md b/website/versioned_docs/version-2.0.0/intro.md deleted file mode 100644 index a8103187d34..00000000000 --- a/website/versioned_docs/version-2.0.0/intro.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Introduction - -The Kubernetes JavaScript Client is the official Node.js client for interacting with Kubernetes clusters. It's written in TypeScript and provides a powerful, type-safe way to manage Kubernetes resources from your Node.js applications. - -## Installation - -Install the client using npm: - -```bash -npm install @kubernetes/client-node -``` - -## Quick Start - -The following example shows how to load your default KubeConfig and list all pods in the `default` namespace. - -```typescript -import * as k8s from '@kubernetes/client-node'; - -const kc = new k8s.KubeConfig(); -kc.loadFromDefault(); - -const k8sApi = kc.makeApiClient(k8s.CoreV1Api); - -async function listPods() { - try { - const res = await k8sApi.listNamespacedPod({ namespace: 'default' }); - console.log( - 'Pods:', - res.items.map((pod) => pod.metadata?.name), - ); - } catch (err) { - console.error('Error:', err); - } -} - -listPods(); -``` - -## KubeConfig Methods - -The `KubeConfig` class provides several ways to load your configuration: - -- `loadFromDefault()`: Loads from the default location (`~/.kube/config` or service account) -- `loadFromFile(path)`: Loads from a specific file -- `loadFromString(content)`: Loads from a YAML string -- `loadFromOptions(options)`: Loads from a programmatic object -- `loadFromCluster()`: Specifically for running inside a cluster (Service Account) - -## Compatibility - -Starting with release `0.13.0`, the minor version of this library tracks the minor Kubernetes API version it was generated from. - -| client version | older versions | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 | 1.33 | 1.34 | -| -------------- | -------------- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | -| 0.19.x | - | ✓ | x | x | x | x | x | x | -| 0.20.x | - | + | ✓ | x | x | x | x | x | -| 0.21.x | - | + | + | ✓ | x | x | x | x | -| 0.22.x | - | + | + | + | ✓ | x | x | x | -| 1.0.x | - | + | + | + | + | ✓ | x | x | -| 1.1.x | - | + | + | + | + | ✓ | x | x | -| 1.2.x | - | + | + | + | + | + | ✓ | x | -| 1.3.x | - | + | + | + | + | + | ✓ | x | -| 1.4.x | - | + | + | + | + | + | + | ✓ | - -**Key:** - -- `✓` Exactly the same features / API objects. -- `+` Client has more features than the cluster, common features work. -- `-` Cluster has features client can't use yet. -- `x` No guarantee of support (outside the n-2 version support window). - -## Links - -- [SDK Reference](/docs/sdk) -- [Kubernetes API Reference](https://kubernetes.io/docs/reference/) -- [GitHub Repository](https://github.com/kubernetes-client/javascript) diff --git a/website/versioned_docs/version-2.0.0/sdk/attach/classes/Attach.md b/website/versioned_docs/version-2.0.0/sdk/attach/classes/Attach.md deleted file mode 100644 index 48cfdf54928..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/attach/classes/Attach.md +++ /dev/null @@ -1,75 +0,0 @@ -# Class: Attach - -Defined in: [src/attach.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/attach.ts#L9) - -## Constructors - -### Constructor - -> **new Attach**(`config`, `websocketInterface?`): `Attach` - -Defined in: [src/attach.ts:14](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/attach.ts#L14) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -##### websocketInterface? - -`WebSocketInterface` - -#### Returns - -`Attach` - -## Properties - -### handler - -> **handler**: `WebSocketInterface` - -Defined in: [src/attach.ts:10](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/attach.ts#L10) - -## Methods - -### attach() - -> **attach**(`namespace`, `podName`, `containerName`, `stdout`, `stderr`, `stdin`, `tty`): `Promise`\<`WebSocket`\> - -Defined in: [src/attach.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/attach.ts#L18) - -#### Parameters - -##### namespace - -`string` - -##### podName - -`string` - -##### containerName - -`string` - -##### stdout - -`any` - -##### stderr - -`any` - -##### stdin - -`any` - -##### tty - -`boolean` - -#### Returns - -`Promise`\<`WebSocket`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/attach/index.md b/website/versioned_docs/version-2.0.0/sdk/attach/index.md deleted file mode 100644 index 5c8b2eedd03..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/attach/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# attach - -## Classes - -- [Attach](classes/Attach.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/classes/ListWatch.md b/website/versioned_docs/version-2.0.0/sdk/cache/classes/ListWatch.md deleted file mode 100644 index b20747defda..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cache/classes/ListWatch.md +++ /dev/null @@ -1,248 +0,0 @@ -# Class: ListWatch\ - -Defined in: [src/cache.ts:26](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L26) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Implements - -- [`ObjectCache`](../interfaces/ObjectCache.md)\<`T`\> -- [`Informer`](../../informer/interfaces/Informer.md)\<`T`\> - -## Constructors - -### Constructor - -> **new ListWatch**\<`T`\>(`path`, `watch`, `listFn`, `autoStart?`, `labelSelector?`, `fieldSelector?`): `ListWatch`\<`T`\> - -Defined in: [src/cache.ts:39](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L39) - -#### Parameters - -##### path - -`string` - -##### watch - -[`Watch`](../../watch/classes/Watch.md) - -##### listFn - -[`ListPromise`](../../informer/type-aliases/ListPromise.md)\<`T`\> - -##### autoStart? - -`boolean` = `true` - -##### labelSelector? - -`string` - -##### fieldSelector? - -`string` - -#### Returns - -`ListWatch`\<`T`\> - -## Methods - -### get() - -> **get**(`name`, `namespace?`): `T` \| `undefined` - -Defined in: [src/cache.ts:113](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L113) - -#### Parameters - -##### name - -`string` - -##### namespace? - -`string` - -#### Returns - -`T` \| `undefined` - -#### Implementation of - -[`ObjectCache`](../interfaces/ObjectCache.md).[`get`](../interfaces/ObjectCache.md#get) - -*** - -### latestResourceVersion() - -> **latestResourceVersion**(): `string` - -Defined in: [src/cache.ts:136](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L136) - -#### Returns - -`string` - -*** - -### list() - -> **list**(`namespace?`): readonly `T`[] - -Defined in: [src/cache.ts:121](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L121) - -#### Parameters - -##### namespace? - -`string` - -#### Returns - -readonly `T`[] - -#### Implementation of - -[`ObjectCache`](../interfaces/ObjectCache.md).[`list`](../interfaces/ObjectCache.md#list) - -*** - -### off() - -#### Call Signature - -> **off**(`verb`, `cb`): `void` - -Defined in: [src/cache.ts:92](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L92) - -##### Parameters - -###### verb - -`"add"` \| `"update"` \| `"change"` \| `"delete"` - -###### cb - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\> - -##### Returns - -`void` - -##### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`off`](../../informer/interfaces/Informer.md#off) - -#### Call Signature - -> **off**(`verb`, `cb`): `void` - -Defined in: [src/cache.ts:93](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L93) - -##### Parameters - -###### verb - -`"connect"` \| `"error"` - -###### cb - -[`ErrorCallback`](../../informer/type-aliases/ErrorCallback.md) - -##### Returns - -`void` - -##### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`off`](../../informer/interfaces/Informer.md#off) - -*** - -### on() - -#### Call Signature - -> **on**(`verb`, `cb`): `void` - -Defined in: [src/cache.ts:74](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L74) - -##### Parameters - -###### verb - -`"add"` \| `"update"` \| `"change"` \| `"delete"` - -###### cb - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\> - -##### Returns - -`void` - -##### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`on`](../../informer/interfaces/Informer.md#on) - -#### Call Signature - -> **on**(`verb`, `cb`): `void` - -Defined in: [src/cache.ts:75](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L75) - -##### Parameters - -###### verb - -`"connect"` \| `"error"` - -###### cb - -[`ErrorCallback`](../../informer/type-aliases/ErrorCallback.md) - -##### Returns - -`void` - -##### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`on`](../../informer/interfaces/Informer.md#on) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [src/cache.ts:64](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L64) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`start`](../../informer/interfaces/Informer.md#start) - -*** - -### stop() - -> **stop**(): `Promise`\<`void`\> - -Defined in: [src/cache.ts:69](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L69) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Informer`](../../informer/interfaces/Informer.md).[`stop`](../../informer/interfaces/Informer.md#stop) diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/functions/addOrUpdateObject.md b/website/versioned_docs/version-2.0.0/sdk/cache/functions/addOrUpdateObject.md deleted file mode 100644 index 4b78ada2d39..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cache/functions/addOrUpdateObject.md +++ /dev/null @@ -1,33 +0,0 @@ -# Function: addOrUpdateObject() - -> **addOrUpdateObject**\<`T`\>(`objects`, `obj`, `addCallbacks?`, `updateCallbacks?`): `void` - -Defined in: [src/cache.ts:296](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L296) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### objects - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -### obj - -`T` - -### addCallbacks? - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] - -### updateCallbacks? - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] - -## Returns - -`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/functions/cacheMapFromList.md b/website/versioned_docs/version-2.0.0/sdk/cache/functions/cacheMapFromList.md deleted file mode 100644 index 9904d10b71a..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cache/functions/cacheMapFromList.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: cacheMapFromList() - -> **cacheMapFromList**\<`T`\>(`newObjects`): [`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -Defined in: [src/cache.ts:244](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L244) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### newObjects - -`T`[] - -## Returns - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteItems.md b/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteItems.md deleted file mode 100644 index 4232db282dd..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteItems.md +++ /dev/null @@ -1,29 +0,0 @@ -# Function: deleteItems() - -> **deleteItems**\<`T`\>(`oldObjects`, `newObjects`, `deleteCallback?`): [`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -Defined in: [src/cache.ts:264](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L264) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### oldObjects - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -### newObjects - -`T`[] - -### deleteCallback? - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] - -## Returns - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteObject.md b/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteObject.md deleted file mode 100644 index a75cb3773e4..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cache/functions/deleteObject.md +++ /dev/null @@ -1,29 +0,0 @@ -# Function: deleteObject() - -> **deleteObject**\<`T`\>(`objects`, `obj`, `deleteCallbacks?`): `void` - -Defined in: [src/cache.ts:334](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L334) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### objects - -[`CacheMap`](../type-aliases/CacheMap.md)\<`T`\> - -### obj - -`T` - -### deleteCallbacks? - -[`ObjectCallback`](../../informer/type-aliases/ObjectCallback.md)\<`T`\>[] - -## Returns - -`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/index.md b/website/versioned_docs/version-2.0.0/sdk/cache/index.md deleted file mode 100644 index 0ad962b28b3..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cache/index.md +++ /dev/null @@ -1,20 +0,0 @@ -# cache - -## Classes - -- [ListWatch](classes/ListWatch.md) - -## Interfaces - -- [ObjectCache](interfaces/ObjectCache.md) - -## Type Aliases - -- [CacheMap](type-aliases/CacheMap.md) - -## Functions - -- [addOrUpdateObject](functions/addOrUpdateObject.md) -- [cacheMapFromList](functions/cacheMapFromList.md) -- [deleteItems](functions/deleteItems.md) -- [deleteObject](functions/deleteObject.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/interfaces/ObjectCache.md b/website/versioned_docs/version-2.0.0/sdk/cache/interfaces/ObjectCache.md deleted file mode 100644 index be504bef243..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cache/interfaces/ObjectCache.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: ObjectCache\ - -Defined in: [src/cache.ts:17](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L17) - -## Type Parameters - -### T - -`T` - -## Methods - -### get() - -> **get**(`name`, `namespace?`): `T` \| `undefined` - -Defined in: [src/cache.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L18) - -#### Parameters - -##### name - -`string` - -##### namespace? - -`string` - -#### Returns - -`T` \| `undefined` - -*** - -### list() - -> **list**(`namespace?`): readonly `T`[] - -Defined in: [src/cache.ts:20](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L20) - -#### Parameters - -##### namespace? - -`string` - -#### Returns - -readonly `T`[] diff --git a/website/versioned_docs/version-2.0.0/sdk/cache/type-aliases/CacheMap.md b/website/versioned_docs/version-2.0.0/sdk/cache/type-aliases/CacheMap.md deleted file mode 100644 index 1adf129fd77..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cache/type-aliases/CacheMap.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: CacheMap\ - -> **CacheMap**\<`T`\> = `Map`\<`string`, `Map`\<`string`, `T`\>\> - -Defined in: [src/cache.ts:24](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cache.ts#L24) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/config/classes/KubeConfig.md b/website/versioned_docs/version-2.0.0/sdk/config/classes/KubeConfig.md deleted file mode 100644 index b39d1bb0df4..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/classes/KubeConfig.md +++ /dev/null @@ -1,559 +0,0 @@ -# Class: KubeConfig - -Defined in: [src/config.ts:68](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L68) - -## Implements - -- `SecurityAuthentication` - -## Constructors - -### Constructor - -> **new KubeConfig**(): `KubeConfig` - -Defined in: [src/config.ts:106](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L106) - -#### Returns - -`KubeConfig` - -## Properties - -### clusters - -> **clusters**: [`Cluster`](../../config_types/interfaces/Cluster.md)[] - -Defined in: [src/config.ts:89](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L89) - -The list of all known clusters - -*** - -### contexts - -> **contexts**: [`Context`](../../config_types/interfaces/Context.md)[] - -Defined in: [src/config.ts:99](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L99) - -The list of all known contexts - -*** - -### currentContext - -> **currentContext**: `string` - -Defined in: [src/config.ts:104](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L104) - -The name of the current context - -*** - -### users - -> **users**: [`User`](../../config_types/interfaces/User.md)[] - -Defined in: [src/config.ts:94](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L94) - -The list of all known users - -## Methods - -### addAuthenticator() - -> **addAuthenticator**(`authenticator`): `void` - -Defined in: [src/config.ts:82](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L82) - -#### Parameters - -##### authenticator - -`Authenticator` - -#### Returns - -`void` - -*** - -### addCluster() - -> **addCluster**(`cluster`): `void` - -Defined in: [src/config.ts:385](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L385) - -#### Parameters - -##### cluster - -[`Cluster`](../../config_types/interfaces/Cluster.md) - -#### Returns - -`void` - -*** - -### addContext() - -> **addContext**(`ctx`): `void` - -Defined in: [src/config.ts:409](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L409) - -#### Parameters - -##### ctx - -[`Context`](../../config_types/interfaces/Context.md) - -#### Returns - -`void` - -*** - -### addUser() - -> **addUser**(`user`): `void` - -Defined in: [src/config.ts:397](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L397) - -#### Parameters - -##### user - -[`User`](../../config_types/interfaces/User.md) - -#### Returns - -`void` - -*** - -### applySecurityAuthentication() - -> **applySecurityAuthentication**(`context`): `Promise`\<`void`\> - -Defined in: [src/config.ts:239](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L239) - -Applies SecurityAuthentication to RequestContext of an API Call from API Client - -#### Parameters - -##### context - -`RequestContext` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -`SecurityAuthentication.applySecurityAuthentication` - -*** - -### applyToFetchOptions() - -> **applyToFetchOptions**(`opts`): `Promise`\<`RequestInit`\> - -Defined in: [src/config.ts:169](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L169) - -#### Parameters - -##### opts - -`RequestOptions` - -#### Returns - -`Promise`\<`RequestInit`\> - -*** - -### applyToHTTPSOptions() - -> **applyToHTTPSOptions**(`opts`): `Promise`\<`void`\> - -Defined in: [src/config.ts:192](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L192) - -#### Parameters - -##### opts - -`any` - -#### Returns - -`Promise`\<`void`\> - -*** - -### exportConfig() - -> **exportConfig**(): `string` - -Defined in: [src/config.ts:526](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L526) - -#### Returns - -`string` - -*** - -### getCluster() - -> **getCluster**(`name`): [`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` - -Defined in: [src/config.ts:147](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L147) - -#### Parameters - -##### name - -`string` - -#### Returns - -[`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` - -*** - -### getClusters() - -> **getClusters**(): [`Cluster`](../../config_types/interfaces/Cluster.md)[] - -Defined in: [src/config.ts:116](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L116) - -#### Returns - -[`Cluster`](../../config_types/interfaces/Cluster.md)[] - -*** - -### getContextObject() - -> **getContextObject**(`name`): [`Context`](../../config_types/interfaces/Context.md) \| `null` - -Defined in: [src/config.ts:132](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L132) - -#### Parameters - -##### name - -`string` - -#### Returns - -[`Context`](../../config_types/interfaces/Context.md) \| `null` - -*** - -### getContexts() - -> **getContexts**(): [`Context`](../../config_types/interfaces/Context.md)[] - -Defined in: [src/config.ts:112](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L112) - -#### Returns - -[`Context`](../../config_types/interfaces/Context.md)[] - -*** - -### getCurrentCluster() - -> **getCurrentCluster**(): [`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` - -Defined in: [src/config.ts:139](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L139) - -#### Returns - -[`Cluster`](../../config_types/interfaces/Cluster.md) \| `null` - -*** - -### getCurrentContext() - -> **getCurrentContext**(): `string` - -Defined in: [src/config.ts:124](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L124) - -#### Returns - -`string` - -*** - -### getCurrentUser() - -> **getCurrentUser**(): [`User`](../../config_types/interfaces/User.md) \| `null` - -Defined in: [src/config.ts:151](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L151) - -#### Returns - -[`User`](../../config_types/interfaces/User.md) \| `null` - -*** - -### getName() - -> **getName**(): `string` - -Defined in: [src/config.ts:285](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L285) - -Returns name of this security authentication method - -#### Returns - -`string` - -string - -#### Implementation of - -`SecurityAuthentication.getName` - -*** - -### getUser() - -> **getUser**(`name`): [`User`](../../config_types/interfaces/User.md) \| `null` - -Defined in: [src/config.ts:159](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L159) - -#### Parameters - -##### name - -`string` - -#### Returns - -[`User`](../../config_types/interfaces/User.md) \| `null` - -*** - -### getUsers() - -> **getUsers**(): [`User`](../../config_types/interfaces/User.md)[] - -Defined in: [src/config.ts:120](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L120) - -#### Returns - -[`User`](../../config_types/interfaces/User.md)[] - -*** - -### loadFromCluster() - -> **loadFromCluster**(`pathPrefix?`): `void` - -Defined in: [src/config.ts:317](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L317) - -#### Parameters - -##### pathPrefix? - -`string` = `''` - -#### Returns - -`void` - -*** - -### loadFromClusterAndUser() - -> **loadFromClusterAndUser**(`cluster`, `user`): `void` - -Defined in: [src/config.ts:304](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L304) - -#### Parameters - -##### cluster - -[`Cluster`](../../config_types/interfaces/Cluster.md) - -##### user - -[`User`](../../config_types/interfaces/User.md) - -#### Returns - -`void` - -*** - -### loadFromDefault() - -> **loadFromDefault**(`opts?`, `contextFromStartingConfig?`, `platform?`): `void` - -Defined in: [src/config.ts:421](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L421) - -#### Parameters - -##### opts? - -`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> - -##### contextFromStartingConfig? - -`boolean` = `false` - -##### platform? - -`string` = `process.platform` - -#### Returns - -`void` - -*** - -### loadFromFile() - -> **loadFromFile**(`file`, `opts?`): `void` - -Defined in: [src/config.ts:163](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L163) - -#### Parameters - -##### file - -`string` - -##### opts? - -`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> - -#### Returns - -`void` - -*** - -### loadFromOptions() - -> **loadFromOptions**(`options`): `void` - -Defined in: [src/config.ts:297](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L297) - -#### Parameters - -##### options - -`any` - -#### Returns - -`void` - -*** - -### loadFromString() - -> **loadFromString**(`config`, `opts?`): `void` - -Defined in: [src/config.ts:289](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L289) - -#### Parameters - -##### config - -`string` - -##### opts? - -`Partial`\<[`ConfigOptions`](../../config_types/interfaces/ConfigOptions.md)\> - -#### Returns - -`void` - -*** - -### makeApiClient() - -> **makeApiClient**\<`T`\>(`apiClientType`): `T` - -Defined in: [src/config.ts:490](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L490) - -#### Type Parameters - -##### T - -`T` *extends* [`ApiType`](../interfaces/ApiType.md) - -#### Parameters - -##### apiClientType - -[`ApiConstructor`](../type-aliases/ApiConstructor.md)\<`T`\> - -#### Returns - -`T` - -*** - -### makePathsAbsolute() - -> **makePathsAbsolute**(`rootDirectory`): `void` - -Defined in: [src/config.ts:510](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L510) - -#### Parameters - -##### rootDirectory - -`string` - -#### Returns - -`void` - -*** - -### mergeConfig() - -> **mergeConfig**(`config`, `preserveContext?`): `void` - -Defined in: [src/config.ts:370](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L370) - -#### Parameters - -##### config - -`KubeConfig` - -##### preserveContext? - -`boolean` = `false` - -#### Returns - -`void` - -*** - -### setCurrentContext() - -> **setCurrentContext**(`context`): `void` - -Defined in: [src/config.ts:128](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L128) - -#### Parameters - -##### context - -`string` - -#### Returns - -`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/functions/bufferFromFileOrString.md b/website/versioned_docs/version-2.0.0/sdk/config/functions/bufferFromFileOrString.md deleted file mode 100644 index 9ac103e5eba..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/functions/bufferFromFileOrString.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: bufferFromFileOrString() - -> **bufferFromFileOrString**(`file?`, `data?`): `Buffer` \| `null` - -Defined in: [src/config.ts:652](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L652) - -## Parameters - -### file? - -`string` - -### data? - -`string` - -## Returns - -`Buffer` \| `null` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/functions/findHomeDir.md b/website/versioned_docs/version-2.0.0/sdk/config/functions/findHomeDir.md deleted file mode 100644 index a27e33a38b6..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/functions/findHomeDir.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: findHomeDir() - -> **findHomeDir**(`platform?`): `string` \| `null` - -Defined in: [src/config.ts:675](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L675) - -## Parameters - -### platform? - -`string` = `process.platform` - -## Returns - -`string` \| `null` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/functions/findObject.md b/website/versioned_docs/version-2.0.0/sdk/config/functions/findObject.md deleted file mode 100644 index b0e9240bd22..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/functions/findObject.md +++ /dev/null @@ -1,29 +0,0 @@ -# Function: findObject() - -> **findObject**\<`T`\>(`list`, `name`, `key`): `T` \| `null` - -Defined in: [src/config.ts:734](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L734) - -## Type Parameters - -### T - -`T` *extends* [`Named`](../interfaces/Named.md) - -## Parameters - -### list - -`T`[] - -### name - -`string` - -### key - -`string` - -## Returns - -`T` \| `null` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/functions/makeAbsolutePath.md b/website/versioned_docs/version-2.0.0/sdk/config/functions/makeAbsolutePath.md deleted file mode 100644 index bba56827920..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/functions/makeAbsolutePath.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: makeAbsolutePath() - -> **makeAbsolutePath**(`root`, `file`): `string` - -Defined in: [src/config.ts:644](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L644) - -## Parameters - -### root - -`string` - -### file - -`string` - -## Returns - -`string` diff --git a/website/versioned_docs/version-2.0.0/sdk/config/index.md b/website/versioned_docs/version-2.0.0/sdk/config/index.md deleted file mode 100644 index 9b7c0e788d9..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# config - -## Classes - -- [KubeConfig](classes/KubeConfig.md) - -## Interfaces - -- [ApiType](interfaces/ApiType.md) -- [Named](interfaces/Named.md) - -## Type Aliases - -- [ApiConstructor](type-aliases/ApiConstructor.md) - -## Functions - -- [bufferFromFileOrString](functions/bufferFromFileOrString.md) -- [findHomeDir](functions/findHomeDir.md) -- [findObject](functions/findObject.md) -- [makeAbsolutePath](functions/makeAbsolutePath.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/config/interfaces/ApiType.md b/website/versioned_docs/version-2.0.0/sdk/config/interfaces/ApiType.md deleted file mode 100644 index 66d6a703b68..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/interfaces/ApiType.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: ApiType - -Defined in: [src/config.ts:66](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L66) diff --git a/website/versioned_docs/version-2.0.0/sdk/config/interfaces/Named.md b/website/versioned_docs/version-2.0.0/sdk/config/interfaces/Named.md deleted file mode 100644 index 092528f642f..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/interfaces/Named.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: Named - -Defined in: [src/config.ts:729](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L729) - -## Properties - -### name - -> **name**: `string` - -Defined in: [src/config.ts:730](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L730) diff --git a/website/versioned_docs/version-2.0.0/sdk/config/type-aliases/ApiConstructor.md b/website/versioned_docs/version-2.0.0/sdk/config/type-aliases/ApiConstructor.md deleted file mode 100644 index 150f0564e7d..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config/type-aliases/ApiConstructor.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ApiConstructor\ - -> **ApiConstructor**\<`T`\> = (`config`) => `T` - -Defined in: [src/config.ts:642](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config.ts#L642) - -## Type Parameters - -### T - -`T` *extends* [`ApiType`](../interfaces/ApiType.md) - -## Parameters - -### config - -`Configuration` - -## Returns - -`T` diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportCluster.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportCluster.md deleted file mode 100644 index 496ceff3a0a..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportCluster.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: exportCluster() - -> **exportCluster**(`cluster`): `any` - -Defined in: [src/config\_types.ts:40](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L40) - -## Parameters - -### cluster - -[`Cluster`](../interfaces/Cluster.md) - -## Returns - -`any` diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportContext.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportContext.md deleted file mode 100644 index db1af685fd2..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportContext.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: exportContext() - -> **exportContext**(`ctx`): `any` - -Defined in: [src/config\_types.ts:190](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L190) - -## Parameters - -### ctx - -[`Context`](../interfaces/Context.md) - -## Returns - -`any` diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportUser.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportUser.md deleted file mode 100644 index 7f63b738075..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/exportUser.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: exportUser() - -> **exportUser**(`user`): `any` - -Defined in: [src/config\_types.ts:113](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L113) - -## Parameters - -### user - -[`User`](../interfaces/User.md) - -## Returns - -`any` diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newClusters.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newClusters.md deleted file mode 100644 index 5e848e742ca..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newClusters.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: newClusters() - -> **newClusters**(`a`, `opts?`): [`Cluster`](../interfaces/Cluster.md)[] - -Defined in: [src/config\_types.ts:30](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L30) - -## Parameters - -### a - -`any` - -### opts? - -`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> - -## Returns - -[`Cluster`](../interfaces/Cluster.md)[] diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newContexts.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newContexts.md deleted file mode 100644 index 6157eb0b7f8..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newContexts.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: newContexts() - -> **newContexts**(`a`, `opts?`): [`Context`](../interfaces/Context.md)[] - -Defined in: [src/config\_types.ts:180](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L180) - -## Parameters - -### a - -`any` - -### opts? - -`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> - -## Returns - -[`Context`](../interfaces/Context.md)[] diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newUsers.md b/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newUsers.md deleted file mode 100644 index c6de2ceb5dc..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/functions/newUsers.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: newUsers() - -> **newUsers**(`a`, `opts?`): [`User`](../interfaces/User.md)[] - -Defined in: [src/config\_types.ts:103](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L103) - -## Parameters - -### a - -`any` - -### opts? - -`Partial`\<[`ConfigOptions`](../interfaces/ConfigOptions.md)\> - -## Returns - -[`User`](../interfaces/User.md)[] diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/index.md b/website/versioned_docs/version-2.0.0/sdk/config_types/index.md deleted file mode 100644 index 35ebc25425d..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/index.md +++ /dev/null @@ -1,25 +0,0 @@ -# config\_types - -## Interfaces - -- [Cluster](interfaces/Cluster.md) -- [ConfigOptions](interfaces/ConfigOptions.md) -- [Context](interfaces/Context.md) -- [User](interfaces/User.md) - -## Type Aliases - -- [ActionOnInvalid](type-aliases/ActionOnInvalid.md) - -## Variables - -- [ActionOnInvalid](variables/ActionOnInvalid.md) - -## Functions - -- [exportCluster](functions/exportCluster.md) -- [exportContext](functions/exportContext.md) -- [exportUser](functions/exportUser.md) -- [newClusters](functions/newClusters.md) -- [newContexts](functions/newContexts.md) -- [newUsers](functions/newUsers.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Cluster.md b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Cluster.md deleted file mode 100644 index 47e14cc8463..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Cluster.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: Cluster - -Defined in: [src/config\_types.ts:20](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L20) - -## Properties - -### caData? - -> `readonly` `optional` **caData?**: `string` - -Defined in: [src/config\_types.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L22) - -*** - -### caFile? - -> `optional` **caFile?**: `string` - -Defined in: [src/config\_types.ts:23](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L23) - -*** - -### name - -> `readonly` **name**: `string` - -Defined in: [src/config\_types.ts:21](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L21) - -*** - -### proxyUrl? - -> `readonly` `optional` **proxyUrl?**: `string` - -Defined in: [src/config\_types.ts:27](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L27) - -*** - -### server - -> `readonly` **server**: `string` - -Defined in: [src/config\_types.ts:24](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L24) - -*** - -### skipTLSVerify - -> `readonly` **skipTLSVerify**: `boolean` - -Defined in: [src/config\_types.ts:26](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L26) - -*** - -### tlsServerName? - -> `readonly` `optional` **tlsServerName?**: `string` - -Defined in: [src/config\_types.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L25) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/ConfigOptions.md b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/ConfigOptions.md deleted file mode 100644 index 2869f14d516..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/ConfigOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# Interface: ConfigOptions - -Defined in: [src/config\_types.ts:10](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L10) - -## Properties - -### onInvalidEntry - -> **onInvalidEntry**: [`ActionOnInvalid`](../type-aliases/ActionOnInvalid.md) - -Defined in: [src/config\_types.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L11) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Context.md b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Context.md deleted file mode 100644 index 809b0be41ff..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/Context.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: Context - -Defined in: [src/config\_types.ts:173](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L173) - -## Properties - -### cluster - -> `readonly` **cluster**: `string` - -Defined in: [src/config\_types.ts:174](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L174) - -*** - -### name - -> `readonly` **name**: `string` - -Defined in: [src/config\_types.ts:176](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L176) - -*** - -### namespace? - -> `readonly` `optional` **namespace?**: `string` - -Defined in: [src/config\_types.ts:177](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L177) - -*** - -### user - -> `readonly` **user**: `string` - -Defined in: [src/config\_types.ts:175](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L175) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/User.md b/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/User.md deleted file mode 100644 index cc1e323b482..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/interfaces/User.md +++ /dev/null @@ -1,91 +0,0 @@ -# Interface: User - -Defined in: [src/config\_types.ts:89](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L89) - -## Properties - -### authProvider? - -> `readonly` `optional` **authProvider?**: `any` - -Defined in: [src/config\_types.ts:96](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L96) - -*** - -### certData? - -> `readonly` `optional` **certData?**: `string` - -Defined in: [src/config\_types.ts:91](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L91) - -*** - -### certFile? - -> `optional` **certFile?**: `string` - -Defined in: [src/config\_types.ts:92](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L92) - -*** - -### exec? - -> `readonly` `optional` **exec?**: `any` - -Defined in: [src/config\_types.ts:93](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L93) - -*** - -### impersonateUser? - -> `readonly` `optional` **impersonateUser?**: `string` - -Defined in: [src/config\_types.ts:100](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L100) - -*** - -### keyData? - -> `readonly` `optional` **keyData?**: `string` - -Defined in: [src/config\_types.ts:94](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L94) - -*** - -### keyFile? - -> `optional` **keyFile?**: `string` - -Defined in: [src/config\_types.ts:95](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L95) - -*** - -### name - -> `readonly` **name**: `string` - -Defined in: [src/config\_types.ts:90](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L90) - -*** - -### password? - -> `readonly` `optional` **password?**: `string` - -Defined in: [src/config\_types.ts:99](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L99) - -*** - -### token? - -> `readonly` `optional` **token?**: `string` - -Defined in: [src/config\_types.ts:97](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L97) - -*** - -### username? - -> `readonly` `optional` **username?**: `string` - -Defined in: [src/config\_types.ts:98](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L98) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/type-aliases/ActionOnInvalid.md b/website/versioned_docs/version-2.0.0/sdk/config_types/type-aliases/ActionOnInvalid.md deleted file mode 100644 index 028306a1640..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/type-aliases/ActionOnInvalid.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ActionOnInvalid - -> **ActionOnInvalid** = *typeof* [`ActionOnInvalid`](../variables/ActionOnInvalid.md)\[keyof *typeof* [`ActionOnInvalid`](../variables/ActionOnInvalid.md)\] - -Defined in: [src/config\_types.ts:3](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L3) diff --git a/website/versioned_docs/version-2.0.0/sdk/config_types/variables/ActionOnInvalid.md b/website/versioned_docs/version-2.0.0/sdk/config_types/variables/ActionOnInvalid.md deleted file mode 100644 index d41d241903c..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/config_types/variables/ActionOnInvalid.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: ActionOnInvalid - -> `const` **ActionOnInvalid**: `object` - -Defined in: [src/config\_types.ts:3](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/config_types.ts#L3) - -## Type Declaration - -### FILTER - -> `readonly` **FILTER**: `"filter"` = `'filter'` - -### THROW - -> `readonly` **THROW**: `"throw"` = `'throw'` diff --git a/website/versioned_docs/version-2.0.0/sdk/cp/classes/Cp.md b/website/versioned_docs/version-2.0.0/sdk/cp/classes/Cp.md deleted file mode 100644 index e5f698eb5d5..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cp/classes/Cp.md +++ /dev/null @@ -1,127 +0,0 @@ -# Class: Cp - -Defined in: [src/cp.ts:7](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L7) - -## Constructors - -### Constructor - -> **new Cp**(`config`, `execInstance?`): `Cp` - -Defined in: [src/cp.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L9) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -##### execInstance? - -[`Exec`](../../exec/classes/Exec.md) - -#### Returns - -`Cp` - -## Properties - -### execInstance - -> **execInstance**: [`Exec`](../../exec/classes/Exec.md) - -Defined in: [src/cp.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L8) - -## Methods - -### cpFromPod() - -> **cpFromPod**(`namespace`, `podName`, `containerName`, `srcPath`, `tgtPath`, `cwd?`): `Promise`\<`void`\> - -Defined in: [src/cp.ts:21](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L21) - -#### Parameters - -##### namespace - -`string` - -The namespace of the pod to exec the command inside. - -##### podName - -`string` - -The name of the pod to exec the command inside. - -##### containerName - -`string` - -The name of the container in the pod to exec the command inside. - -##### srcPath - -`string` - -The source path in the pod - -##### tgtPath - -`string` - -The target path in local - -##### cwd? - -`string` - -The directory that is used as the parent in the pod when downloading - -#### Returns - -`Promise`\<`void`\> - -*** - -### cpToPod() - -> **cpToPod**(`namespace`, `podName`, `containerName`, `srcPath`, `tgtPath`): `Promise`\<`void`\> - -Defined in: [src/cp.ts:60](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/cp.ts#L60) - -#### Parameters - -##### namespace - -`string` - -The namespace of the pod to exec the command inside. - -##### podName - -`string` - -The name of the pod to exec the command inside. - -##### containerName - -`string` - -The name of the container in the pod to exec the command inside. - -##### srcPath - -`string` - -The source path in local - -##### tgtPath - -`string` - -The target path in the pod - -#### Returns - -`Promise`\<`void`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/cp/index.md b/website/versioned_docs/version-2.0.0/sdk/cp/index.md deleted file mode 100644 index 67baee4077a..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/cp/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# cp - -## Classes - -- [Cp](classes/Cp.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/exec/classes/Exec.md b/website/versioned_docs/version-2.0.0/sdk/exec/classes/Exec.md deleted file mode 100644 index 121681e46fb..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/exec/classes/Exec.md +++ /dev/null @@ -1,103 +0,0 @@ -# Class: Exec - -Defined in: [src/exec.ts:10](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/exec.ts#L10) - -## Constructors - -### Constructor - -> **new Exec**(`config`, `wsInterface?`): `Exec` - -Defined in: [src/exec.ts:15](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/exec.ts#L15) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -##### wsInterface? - -`WebSocketInterface` - -#### Returns - -`Exec` - -## Properties - -### handler - -> **handler**: `WebSocketInterface` - -Defined in: [src/exec.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/exec.ts#L11) - -## Methods - -### exec() - -> **exec**(`namespace`, `podName`, `containerName`, `command`, `stdout`, `stderr`, `stdin`, `tty`, `statusCallback?`): `Promise`\<`WebSocket`\> - -Defined in: [src/exec.ts:32](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/exec.ts#L32) - -#### Parameters - -##### namespace - -`string` - -The namespace of the pod to exec the command inside. - -##### podName - -`string` - -The name of the pod to exec the command inside. - -##### containerName - -`string` - -The name of the container in the pod to exec the command inside. - -##### command - -`string` \| `string`[] - -The command or command and arguments to execute. - -##### stdout - -`Writable` \| `null` - -The stream to write stdout data from the command. - -##### stderr - -`Writable` \| `null` - -The stream to write stderr data from the command. - -##### stdin - -`Readable` \| `null` - -The stream to write stdin data into the command. - -##### tty - -`boolean` - -Should the command execute in a TTY enabled session. - -##### statusCallback? - -(`status`) => `void` - -A callback to received the status (e.g. exit code) from the command, optional. - -#### Returns - -`Promise`\<`WebSocket`\> - -A promise that will return the web socket created for this command. diff --git a/website/versioned_docs/version-2.0.0/sdk/exec/index.md b/website/versioned_docs/version-2.0.0/sdk/exec/index.md deleted file mode 100644 index 84d31a7aad2..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/exec/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# exec - -## Classes - -- [Exec](classes/Exec.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/health/classes/Health.md b/website/versioned_docs/version-2.0.0/sdk/health/classes/Health.md deleted file mode 100644 index a258ccfa9b3..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/health/classes/Health.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: Health - -Defined in: [src/health.ts:5](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L5) - -## Constructors - -### Constructor - -> **new Health**(`config`): `Health` - -Defined in: [src/health.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L8) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -#### Returns - -`Health` - -## Properties - -### config - -> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) - -Defined in: [src/health.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L6) - -## Methods - -### livez() - -> **livez**(`opts`): `Promise`\<`boolean`\> - -Defined in: [src/health.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L16) - -#### Parameters - -##### opts - -`RequestOptions` - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### readyz() - -> **readyz**(`opts`): `Promise`\<`boolean`\> - -Defined in: [src/health.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/health.ts#L12) - -#### Parameters - -##### opts - -`RequestOptions` - -#### Returns - -`Promise`\<`boolean`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/health/index.md b/website/versioned_docs/version-2.0.0/sdk/health/index.md deleted file mode 100644 index ee17d9e0f20..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/health/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# health - -## Classes - -- [Health](classes/Health.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/index.md b/website/versioned_docs/version-2.0.0/sdk/index.md deleted file mode 100644 index 206b899986f..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/index.md +++ /dev/null @@ -1,22 +0,0 @@ -# @kubernetes/client-node - -## Modules - -- [attach](attach/index.md) -- [cache](cache/index.md) -- [config](config/index.md) -- [config\_types](config_types/index.md) -- [cp](cp/index.md) -- [exec](exec/index.md) -- [health](health/index.md) -- [informer](informer/index.md) -- [log](log/index.md) -- [metrics](metrics/index.md) -- [middleware](middleware/index.md) -- [object](object/index.md) -- [patch](patch/index.md) -- [portforward](portforward/index.md) -- [top](top/index.md) -- [types](types/index.md) -- [watch](watch/index.md) -- [yaml](yaml/index.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/functions/makeInformer.md b/website/versioned_docs/version-2.0.0/sdk/informer/functions/makeInformer.md deleted file mode 100644 index 18a75355eaa..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/functions/makeInformer.md +++ /dev/null @@ -1,33 +0,0 @@ -# Function: makeInformer() - -> **makeInformer**\<`T`\>(`kubeconfig`, `path`, `listPromiseFn`, `labelSelector?`): [`Informer`](../interfaces/Informer.md)\<`T`\> & [`ObjectCache`](../../cache/interfaces/ObjectCache.md)\<`T`\> - -Defined in: [src/informer.ts:37](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L37) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### kubeconfig - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -### path - -`string` - -### listPromiseFn - -[`ListPromise`](../type-aliases/ListPromise.md)\<`T`\> - -### labelSelector? - -`string` - -## Returns - -[`Informer`](../interfaces/Informer.md)\<`T`\> & [`ObjectCache`](../../cache/interfaces/ObjectCache.md)\<`T`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/index.md b/website/versioned_docs/version-2.0.0/sdk/informer/index.md deleted file mode 100644 index b8b436f663a..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/index.md +++ /dev/null @@ -1,31 +0,0 @@ -# informer - -## Interfaces - -- [Informer](interfaces/Informer.md) - -## Type Aliases - -- [ADD](type-aliases/ADD.md) -- [CHANGE](type-aliases/CHANGE.md) -- [CONNECT](type-aliases/CONNECT.md) -- [DELETE](type-aliases/DELETE.md) -- [ERROR](type-aliases/ERROR.md) -- [ErrorCallback](type-aliases/ErrorCallback.md) -- [ListCallback](type-aliases/ListCallback.md) -- [ListPromise](type-aliases/ListPromise.md) -- [ObjectCallback](type-aliases/ObjectCallback.md) -- [UPDATE](type-aliases/UPDATE.md) - -## Variables - -- [ADD](variables/ADD.md) -- [CHANGE](variables/CHANGE.md) -- [CONNECT](variables/CONNECT.md) -- [DELETE](variables/DELETE.md) -- [ERROR](variables/ERROR.md) -- [UPDATE](variables/UPDATE.md) - -## Functions - -- [makeInformer](functions/makeInformer.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/interfaces/Informer.md b/website/versioned_docs/version-2.0.0/sdk/informer/interfaces/Informer.md deleted file mode 100644 index 81bd4c3ed86..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/interfaces/Informer.md +++ /dev/null @@ -1,121 +0,0 @@ -# Interface: Informer\ - -Defined in: [src/informer.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L28) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Methods - -### off() - -#### Call Signature - -> **off**(`verb`, `cb`): `void` - -Defined in: [src/informer.ts:31](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L31) - -##### Parameters - -###### verb - -`"add"` \| `"update"` \| `"change"` \| `"delete"` - -###### cb - -[`ObjectCallback`](../type-aliases/ObjectCallback.md)\<`T`\> - -##### Returns - -`void` - -#### Call Signature - -> **off**(`verb`, `cb`): `void` - -Defined in: [src/informer.ts:32](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L32) - -##### Parameters - -###### verb - -`"connect"` \| `"error"` - -###### cb - -[`ErrorCallback`](../type-aliases/ErrorCallback.md) - -##### Returns - -`void` - -*** - -### on() - -#### Call Signature - -> **on**(`verb`, `cb`): `void` - -Defined in: [src/informer.ts:29](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L29) - -##### Parameters - -###### verb - -`"add"` \| `"update"` \| `"change"` \| `"delete"` - -###### cb - -[`ObjectCallback`](../type-aliases/ObjectCallback.md)\<`T`\> - -##### Returns - -`void` - -#### Call Signature - -> **on**(`verb`, `cb`): `void` - -Defined in: [src/informer.ts:30](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L30) - -##### Parameters - -###### verb - -`"connect"` \| `"error"` - -###### cb - -[`ErrorCallback`](../type-aliases/ErrorCallback.md) - -##### Returns - -`void` - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [src/informer.ts:33](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L33) - -#### Returns - -`Promise`\<`void`\> - -*** - -### stop() - -> **stop**(): `Promise`\<`void`\> - -Defined in: [src/informer.ts:34](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L34) - -#### Returns - -`Promise`\<`void`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ADD.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ADD.md deleted file mode 100644 index 0107347e998..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ADD.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ADD - -> **ADD** = *typeof* [`ADD`](../variables/ADD.md) - -Defined in: [src/informer.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L12) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CHANGE.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CHANGE.md deleted file mode 100644 index 49048593132..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CHANGE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CHANGE - -> **CHANGE** = *typeof* [`CHANGE`](../variables/CHANGE.md) - -Defined in: [src/informer.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L16) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CONNECT.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CONNECT.md deleted file mode 100644 index cbc095cf9e9..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/CONNECT.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CONNECT - -> **CONNECT** = *typeof* [`CONNECT`](../variables/CONNECT.md) - -Defined in: [src/informer.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L22) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/DELETE.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/DELETE.md deleted file mode 100644 index e6376538bb5..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/DELETE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: DELETE - -> **DELETE** = *typeof* [`DELETE`](../variables/DELETE.md) - -Defined in: [src/informer.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L18) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ERROR.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ERROR.md deleted file mode 100644 index 42123e01c3b..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ERROR.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ERROR - -> **ERROR** = *typeof* [`ERROR`](../variables/ERROR.md) - -Defined in: [src/informer.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L25) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ErrorCallback.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ErrorCallback.md deleted file mode 100644 index fe41f7e4a22..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ErrorCallback.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ErrorCallback - -> **ErrorCallback** = (`err?`) => `void` - -Defined in: [src/informer.ts:7](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L7) - -## Parameters - -### err? - -`any` - -## Returns - -`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListCallback.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListCallback.md deleted file mode 100644 index 6eadafcd6f3..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListCallback.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: ListCallback\ - -> **ListCallback**\<`T`\> = (`list`, `ResourceVersion`) => `void` - -Defined in: [src/informer.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L8) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### list - -`T`[] - -### ResourceVersion - -`string` - -## Returns - -`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListPromise.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListPromise.md deleted file mode 100644 index 947561b43b2..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ListPromise.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ListPromise\ - -> **ListPromise**\<`T`\> = () => `Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> - -Defined in: [src/informer.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L9) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Returns - -`Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ObjectCallback.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ObjectCallback.md deleted file mode 100644 index d95dc7d57e2..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/ObjectCallback.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ObjectCallback\ - -> **ObjectCallback**\<`T`\> = (`obj`) => `void` - -Defined in: [src/informer.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L6) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -## Parameters - -### obj - -`T` - -## Returns - -`void` diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/UPDATE.md b/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/UPDATE.md deleted file mode 100644 index 00e792210e4..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/type-aliases/UPDATE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: UPDATE - -> **UPDATE** = *typeof* [`UPDATE`](../variables/UPDATE.md) - -Defined in: [src/informer.ts:14](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L14) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/ADD.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/ADD.md deleted file mode 100644 index e48e8fea6ad..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/variables/ADD.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: ADD - -> `const` **ADD**: `"add"` = `'add'` - -Defined in: [src/informer.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L12) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/CHANGE.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/CHANGE.md deleted file mode 100644 index d3415f562dc..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/variables/CHANGE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: CHANGE - -> `const` **CHANGE**: `"change"` = `'change'` - -Defined in: [src/informer.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L16) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/CONNECT.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/CONNECT.md deleted file mode 100644 index 0ddbe5e4c90..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/variables/CONNECT.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: CONNECT - -> `const` **CONNECT**: `"connect"` = `'connect'` - -Defined in: [src/informer.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L22) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/DELETE.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/DELETE.md deleted file mode 100644 index 2c609f84aa1..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/variables/DELETE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: DELETE - -> `const` **DELETE**: `"delete"` = `'delete'` - -Defined in: [src/informer.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L18) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/ERROR.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/ERROR.md deleted file mode 100644 index 1e9be8bf66d..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/variables/ERROR.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: ERROR - -> `const` **ERROR**: `"error"` = `'error'` - -Defined in: [src/informer.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L25) diff --git a/website/versioned_docs/version-2.0.0/sdk/informer/variables/UPDATE.md b/website/versioned_docs/version-2.0.0/sdk/informer/variables/UPDATE.md deleted file mode 100644 index eb3ce387be5..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/informer/variables/UPDATE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: UPDATE - -> `const` **UPDATE**: `"update"` = `'update'` - -Defined in: [src/informer.ts:14](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/informer.ts#L14) diff --git a/website/versioned_docs/version-2.0.0/sdk/log/classes/Log.md b/website/versioned_docs/version-2.0.0/sdk/log/classes/Log.md deleted file mode 100644 index f1b4e2310b1..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/log/classes/Log.md +++ /dev/null @@ -1,105 +0,0 @@ -# Class: Log - -Defined in: [src/log.ts:84](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L84) - -## Constructors - -### Constructor - -> **new Log**(`config`): `Log` - -Defined in: [src/log.ts:87](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L87) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -#### Returns - -`Log` - -## Properties - -### config - -> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) - -Defined in: [src/log.ts:85](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L85) - -## Methods - -### log() - -#### Call Signature - -> **log**(`namespace`, `podName`, `containerName`, `stream`, `options?`): `Promise`\<`AbortController`\> - -Defined in: [src/log.ts:91](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L91) - -##### Parameters - -###### namespace - -`string` - -###### podName - -`string` - -###### containerName - -`string` - -###### stream - -`Writable` - -###### options? - -[`LogOptions`](../interfaces/LogOptions.md) - -##### Returns - -`Promise`\<`AbortController`\> - -#### Call Signature - -> **log**(`namespace`, `podName`, `containerName`, `stream`, `done`, `options?`): `Promise`\<`AbortController`\> - -Defined in: [src/log.ts:99](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L99) - -##### Parameters - -###### namespace - -`string` - -###### podName - -`string` - -###### containerName - -`string` - -###### stream - -`Writable` - -###### done - -(`err`) => `void` - -###### options? - -[`LogOptions`](../interfaces/LogOptions.md) - -##### Returns - -`Promise`\<`AbortController`\> - -##### Deprecated - -done callback is deprecated diff --git a/website/versioned_docs/version-2.0.0/sdk/log/functions/AddOptionsToSearchParams.md b/website/versioned_docs/version-2.0.0/sdk/log/functions/AddOptionsToSearchParams.md deleted file mode 100644 index 654abbab248..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/log/functions/AddOptionsToSearchParams.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: AddOptionsToSearchParams() - -> **AddOptionsToSearchParams**(`options`, `searchParams`): `URLSearchParams` \| `undefined` - -Defined in: [src/log.ts:55](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L55) - -## Parameters - -### options - -[`LogOptions`](../interfaces/LogOptions.md) \| `undefined` - -### searchParams - -`URLSearchParams` - -## Returns - -`URLSearchParams` \| `undefined` diff --git a/website/versioned_docs/version-2.0.0/sdk/log/index.md b/website/versioned_docs/version-2.0.0/sdk/log/index.md deleted file mode 100644 index fd0405bfa4d..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/log/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# log - -## Classes - -- [Log](classes/Log.md) - -## Interfaces - -- [LogOptions](interfaces/LogOptions.md) - -## Functions - -- [AddOptionsToSearchParams](functions/AddOptionsToSearchParams.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/log/interfaces/LogOptions.md b/website/versioned_docs/version-2.0.0/sdk/log/interfaces/LogOptions.md deleted file mode 100644 index 7428d8fc48d..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/log/interfaces/LogOptions.md +++ /dev/null @@ -1,88 +0,0 @@ -# Interface: LogOptions - -Defined in: [src/log.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L8) - -## Properties - -### follow? - -> `optional` **follow?**: `boolean` - -Defined in: [src/log.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L12) - -Follow the log stream of the pod. Defaults to false. - -*** - -### limitBytes? - -> `optional` **limitBytes?**: `number` - -Defined in: [src/log.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L18) - -If set, the number of bytes to read from the server before terminating the log output. This may not display a -complete final line of logging, and may return slightly more or slightly less than the specified limit. - -*** - -### pretty? - -> `optional` **pretty?**: `boolean` - -Defined in: [src/log.ts:23](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L23) - -If true, then the output is pretty printed. - -*** - -### previous? - -> `optional` **previous?**: `boolean` - -Defined in: [src/log.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L28) - -Return previous terminated container logs. Defaults to false. - -*** - -### sinceSeconds? - -> `optional` **sinceSeconds?**: `number` - -Defined in: [src/log.ts:35](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L35) - -A relative time in seconds before the current time from which to show logs. If this value precedes the time a -pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will -be returned. Only one of sinceSeconds or sinceTime may be specified. - -*** - -### sinceTime? - -> `optional` **sinceTime?**: `string` - -Defined in: [src/log.ts:41](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L41) - -Only return logs after a specific date (RFC3339). Defaults to all logs. -Only one of sinceSeconds or sinceTime may be specified. - -*** - -### tailLines? - -> `optional` **tailLines?**: `number` - -Defined in: [src/log.ts:47](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L47) - -If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation -of the container or sinceSeconds or sinceTime - -*** - -### timestamps? - -> `optional` **timestamps?**: `boolean` - -Defined in: [src/log.ts:52](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/log.ts#L52) - -If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/classes/Metrics.md b/website/versioned_docs/version-2.0.0/sdk/metrics/classes/Metrics.md deleted file mode 100644 index 9014336e2cc..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/metrics/classes/Metrics.md +++ /dev/null @@ -1,51 +0,0 @@ -# Class: Metrics - -Defined in: [src/metrics.ts:57](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L57) - -## Constructors - -### Constructor - -> **new Metrics**(`config`): `Metrics` - -Defined in: [src/metrics.ts:60](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L60) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -#### Returns - -`Metrics` - -## Methods - -### getNodeMetrics() - -> **getNodeMetrics**(): `Promise`\<[`NodeMetricsList`](../interfaces/NodeMetricsList.md)\> - -Defined in: [src/metrics.ts:64](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L64) - -#### Returns - -`Promise`\<[`NodeMetricsList`](../interfaces/NodeMetricsList.md)\> - -*** - -### getPodMetrics() - -> **getPodMetrics**(`namespace?`): `Promise`\<[`PodMetricsList`](../interfaces/PodMetricsList.md)\> - -Defined in: [src/metrics.ts:68](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L68) - -#### Parameters - -##### namespace? - -`string` - -#### Returns - -`Promise`\<[`PodMetricsList`](../interfaces/PodMetricsList.md)\> diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/index.md b/website/versioned_docs/version-2.0.0/sdk/metrics/index.md deleted file mode 100644 index 21d120f931e..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/metrics/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# metrics - -## Classes - -- [Metrics](classes/Metrics.md) - -## Interfaces - -- [ContainerMetric](interfaces/ContainerMetric.md) -- [NodeMetric](interfaces/NodeMetric.md) -- [NodeMetricsList](interfaces/NodeMetricsList.md) -- [PodMetric](interfaces/PodMetric.md) -- [PodMetricsList](interfaces/PodMetricsList.md) -- [Usage](interfaces/Usage.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/ContainerMetric.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/ContainerMetric.md deleted file mode 100644 index afded7d7caa..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/ContainerMetric.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: ContainerMetric - -Defined in: [src/metrics.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L11) - -## Properties - -### name - -> **name**: `string` - -Defined in: [src/metrics.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L12) - -*** - -### usage - -> **usage**: [`Usage`](Usage.md) - -Defined in: [src/metrics.ts:13](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L13) diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetric.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetric.md deleted file mode 100644 index fc4d43622ec..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetric.md +++ /dev/null @@ -1,47 +0,0 @@ -# Interface: NodeMetric - -Defined in: [src/metrics.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L28) - -## Properties - -### metadata - -> **metadata**: `object` - -Defined in: [src/metrics.ts:29](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L29) - -#### creationTimestamp - -> **creationTimestamp**: `string` - -#### name - -> **name**: `string` - -#### selfLink - -> **selfLink**: `string` - -*** - -### timestamp - -> **timestamp**: `string` - -Defined in: [src/metrics.ts:34](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L34) - -*** - -### usage - -> **usage**: [`Usage`](Usage.md) - -Defined in: [src/metrics.ts:36](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L36) - -*** - -### window - -> **window**: `string` - -Defined in: [src/metrics.ts:35](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L35) diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetricsList.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetricsList.md deleted file mode 100644 index 73266758061..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/NodeMetricsList.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: NodeMetricsList - -Defined in: [src/metrics.ts:48](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L48) - -## Properties - -### apiVersion - -> **apiVersion**: `"metrics.k8s.io/v1beta1"` - -Defined in: [src/metrics.ts:50](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L50) - -*** - -### items - -> **items**: [`NodeMetric`](NodeMetric.md)[] - -Defined in: [src/metrics.ts:54](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L54) - -*** - -### kind - -> **kind**: `"NodeMetricsList"` - -Defined in: [src/metrics.ts:49](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L49) - -*** - -### metadata - -> **metadata**: `object` - -Defined in: [src/metrics.ts:51](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L51) - -#### selfLink - -> **selfLink**: `string` diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetric.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetric.md deleted file mode 100644 index 0cf3af5384c..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetric.md +++ /dev/null @@ -1,51 +0,0 @@ -# Interface: PodMetric - -Defined in: [src/metrics.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L16) - -## Properties - -### containers - -> **containers**: [`ContainerMetric`](ContainerMetric.md)[] - -Defined in: [src/metrics.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L25) - -*** - -### metadata - -> **metadata**: `object` - -Defined in: [src/metrics.ts:17](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L17) - -#### creationTimestamp - -> **creationTimestamp**: `string` - -#### name - -> **name**: `string` - -#### namespace - -> **namespace**: `string` - -#### selfLink - -> **selfLink**: `string` - -*** - -### timestamp - -> **timestamp**: `string` - -Defined in: [src/metrics.ts:23](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L23) - -*** - -### window - -> **window**: `string` - -Defined in: [src/metrics.ts:24](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L24) diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetricsList.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetricsList.md deleted file mode 100644 index 5a3bd59ebc0..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/PodMetricsList.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: PodMetricsList - -Defined in: [src/metrics.ts:39](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L39) - -## Properties - -### apiVersion - -> **apiVersion**: `"metrics.k8s.io/v1beta1"` - -Defined in: [src/metrics.ts:41](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L41) - -*** - -### items - -> **items**: [`PodMetric`](PodMetric.md)[] - -Defined in: [src/metrics.ts:45](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L45) - -*** - -### kind - -> **kind**: `"PodMetricsList"` - -Defined in: [src/metrics.ts:40](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L40) - -*** - -### metadata - -> **metadata**: `object` - -Defined in: [src/metrics.ts:42](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L42) - -#### selfLink - -> **selfLink**: `string` diff --git a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/Usage.md b/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/Usage.md deleted file mode 100644 index 5c196e5885f..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/metrics/interfaces/Usage.md +++ /dev/null @@ -1,19 +0,0 @@ -# Interface: Usage - -Defined in: [src/metrics.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L6) - -## Properties - -### cpu - -> **cpu**: `string` - -Defined in: [src/metrics.ts:7](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L7) - -*** - -### memory - -> **memory**: `string` - -Defined in: [src/metrics.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/metrics.ts#L8) diff --git a/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderMiddleware.md b/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderMiddleware.md deleted file mode 100644 index c2354765ba2..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderMiddleware.md +++ /dev/null @@ -1,19 +0,0 @@ -# Function: setHeaderMiddleware() - -> **setHeaderMiddleware**(`key`, `value`): `Middleware` - -Defined in: [src/middleware.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/middleware.ts#L9) - -## Parameters - -### key - -`string` - -### value - -`string` - -## Returns - -`Middleware` diff --git a/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderOptions.md b/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderOptions.md deleted file mode 100644 index 622dbccbf2c..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/middleware/functions/setHeaderOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -# Function: setHeaderOptions() - -> **setHeaderOptions**(`key`, `value`, `opt?`): `ConfigurationOptions`\<`Middleware`\> - -Defined in: [src/middleware.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/middleware.ts#L22) - -## Parameters - -### key - -`string` - -### value - -`string` - -### opt? - -`ConfigurationOptions`\<`Middleware`\> - -## Returns - -`ConfigurationOptions`\<`Middleware`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/middleware/index.md b/website/versioned_docs/version-2.0.0/sdk/middleware/index.md deleted file mode 100644 index cffdb06008c..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/middleware/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# middleware - -## Functions - -- [setHeaderMiddleware](functions/setHeaderMiddleware.md) -- [setHeaderOptions](functions/setHeaderOptions.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/object/classes/KubernetesObjectApi.md b/website/versioned_docs/version-2.0.0/sdk/object/classes/KubernetesObjectApi.md deleted file mode 100644 index 77fd7fe91fe..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/object/classes/KubernetesObjectApi.md +++ /dev/null @@ -1,466 +0,0 @@ -# Class: KubernetesObjectApi - -Defined in: [src/object.ts:37](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L37) - -Dynamically construct Kubernetes API request URIs so client does not have to know what type of object it is acting -on. - -## Constructors - -### Constructor - -> **new KubernetesObjectApi**(`configuration`): `KubernetesObjectApi` - -Defined in: [src/object.ts:59](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L59) - -#### Parameters - -##### configuration - -`Configuration` - -#### Returns - -`KubernetesObjectApi` - -## Methods - -### create() - -> **create**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `options?`): `Promise`\<`T`\> - -Defined in: [src/object.ts:76](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L76) - -Create any Kubernetes resource. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### spec - -`T` - -Kubernetes resource spec. - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### dryRun? - -`string` - -When present, indicates that modifications should not be persisted. An invalid or unrecognized - dryRun directive will result in an error response and no further processing of the request. Valid values - are: - All: all dry run stages will be processed - -##### fieldManager? - -`string` - -fieldManager is a name associated with the actor or entity that is making these changes. The - value must be less than or 128 characters long, and only contain printable characters, as defined by - https://golang.org/pkg/unicode/#IsPrint. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`T`\> - -Promise containing the request response and [[KubernetesObject]]. - -*** - -### delete() - -> **delete**(`spec`, `pretty?`, `dryRun?`, `gracePeriodSeconds?`, `orphanDependents?`, `propagationPolicy?`, `body?`, `options?`): `Promise`\<`V1Status`\> - -Defined in: [src/object.ts:145](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L145) - -Delete any Kubernetes resource. - -#### Parameters - -##### spec - -[`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -Kubernetes resource spec - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### dryRun? - -`string` - -When present, indicates that modifications should not be persisted. An invalid or unrecognized - dryRun directive will result in an error response and no further processing of the request. Valid values - are: - All: all dry run stages will be processed - -##### gracePeriodSeconds? - -`number` - -The duration in seconds before the object should be deleted. Value must be non-negative - integer. The value zero indicates delete immediately. If this value is nil, the default grace period for - the specified type will be used. Defaults to a per object value if not specified. zero means delete - immediately. - -##### orphanDependents? - -`boolean` - -Deprecated: please use the PropagationPolicy, this field will be deprecated in - 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be - added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be - set, but not both. - -##### propagationPolicy? - -`string` - -Whether and how garbage collection will be performed. Either this field or - OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in - the metadata.finalizers and the resource-specific default policy. Acceptable values are: - \'Orphan\' - orphan the dependents; \'Background\' - allow the garbage collector to delete - the dependents in the background; \'Foreground\' - a cascading policy that deletes all dependents - in the foreground. - -##### body? - -`V1DeleteOptions` - -See [[V1DeleteOptions]]. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`V1Status`\> - -Promise containing the request response and a Kubernetes [[V1Status]]. - -*** - -### list() - -> **list**\<`T`\>(`apiVersion`, `kind`, `namespace?`, `pretty?`, `exact?`, `exportt?`, `fieldSelector?`, `labelSelector?`, `limit?`, `continueToken?`, `options?`): `Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> - -Defined in: [src/object.ts:349](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L349) - -List any Kubernetes resources. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### apiVersion - -`string` - -api group and version of the form / - -##### kind - -`string` - -Kubernetes resource kind - -##### namespace? - -`string` - -list resources in this namespace - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### exact? - -`boolean` - -Should the export be exact. Exact export maintains cluster-specific fields like - \'Namespace\'. Deprecated. Planned for removal in 1.18. - -##### exportt? - -`boolean` - -Should this value be exported. Export strips fields that a user can not - specify. Deprecated. Planned for removal in 1.18. - -##### fieldSelector? - -`string` - -A selector to restrict the list of returned objects by their fields. Defaults to everything. - -##### labelSelector? - -`string` - -A selector to restrict the list of returned objects by their labels. Defaults to everything. - -##### limit? - -`number` - -Number of returned resources. - -##### continueToken? - -`string` - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<[`KubernetesListObject`](../../types/interfaces/KubernetesListObject.md)\<`T`\>\> - -Promise containing the request response and [[KubernetesListObject]]. - -*** - -### patch() - -> **patch**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `force?`, `patchStrategy?`, `options?`): `Promise`\<`T`\> - -Defined in: [src/object.ts:230](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L230) - -Patch any Kubernetes resource. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### spec - -`T` - -Kubernetes resource spec - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### dryRun? - -`string` - -When present, indicates that modifications should not be persisted. An invalid or unrecognized - dryRun directive will result in an error response and no further processing of the request. Valid values - are: - All: all dry run stages will be processed - -##### fieldManager? - -`string` - -fieldManager is a name associated with the actor or entity that is making these changes. The - value must be less than or 128 characters long, and only contain printable characters, as defined by - https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests - (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, - StrategicMergePatch). - -##### force? - -`boolean` - -Force is going to \"force\" Apply requests. It means user will re-acquire conflicting - fields owned by other people. Force flag must be unset for non-apply patch requests. - -##### patchStrategy? - -[`PatchStrategy`](../../patch/type-aliases/PatchStrategy.md) = `PatchStrategy.StrategicMergePatch` - -Content-Type header used to control how the patch will be performed. See - See https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ - for details. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`T`\> - -Promise containing the request response and [[KubernetesObject]]. - -*** - -### read() - -> **read**\<`T`\>(`spec`, `pretty?`, `exact?`, `exportt?`, `options?`): `Promise`\<`T`\> - -Defined in: [src/object.ts:292](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L292) - -Read any Kubernetes resource. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### spec - -`KubernetesObjectHeader`\<`T`\> - -Kubernetes resource spec - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### exact? - -`boolean` - -Should the export be exact. Exact export maintains cluster-specific fields like - \'Namespace\'. Deprecated. Planned for removal in 1.18. - -##### exportt? - -`boolean` - -Should this value be exported. Export strips fields that a user can not - specify. Deprecated. Planned for removal in 1.18. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`T`\> - -Promise containing the request response and [[KubernetesObject]]. - -*** - -### replace() - -> **replace**\<`T`\>(`spec`, `pretty?`, `dryRun?`, `fieldManager?`, `options?`): `Promise`\<`T`\> - -Defined in: [src/object.ts:436](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L436) - -Replace any Kubernetes resource. - -#### Type Parameters - -##### T - -`T` *extends* [`KubernetesObject`](../../types/interfaces/KubernetesObject.md) - -#### Parameters - -##### spec - -`T` - -Kubernetes resource spec - -##### pretty? - -`string` - -If \'true\', then the output is pretty printed. - -##### dryRun? - -`string` - -When present, indicates that modifications should not be persisted. An invalid or unrecognized - dryRun directive will result in an error response and no further processing of the request. Valid values - are: - All: all dry run stages will be processed - -##### fieldManager? - -`string` - -fieldManager is a name associated with the actor or entity that is making these changes. The - value must be less than or 128 characters long, and only contain printable characters, as defined by - https://golang.org/pkg/unicode/#IsPrint. - -##### options? - -`Configuration`\<`Middleware`\> - -Optional headers to use in the request. - -#### Returns - -`Promise`\<`T`\> - -Promise containing the request response and [[KubernetesObject]]. - -*** - -### makeApiClient() - -> `static` **makeApiClient**(`kc`): `KubernetesObjectApi` - -Defined in: [src/object.ts:46](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/object.ts#L46) - -Create a KubernetesObjectApi object from the provided KubeConfig. This method should be used rather than -[[KubeConfig.makeApiClient]] so we can properly determine the default namespace if one is provided by the current -context. - -#### Parameters - -##### kc - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -Valid Kubernetes config - -#### Returns - -`KubernetesObjectApi` - -Properly instantiated [[KubernetesObjectApi]] object diff --git a/website/versioned_docs/version-2.0.0/sdk/object/index.md b/website/versioned_docs/version-2.0.0/sdk/object/index.md deleted file mode 100644 index 82633830a1e..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/object/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# object - -## Classes - -- [KubernetesObjectApi](classes/KubernetesObjectApi.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/patch/index.md b/website/versioned_docs/version-2.0.0/sdk/patch/index.md deleted file mode 100644 index 33a10aae72b..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/patch/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# patch - -## Type Aliases - -- [PatchStrategy](type-aliases/PatchStrategy.md) - -## Variables - -- [PatchStrategy](variables/PatchStrategy.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/patch/type-aliases/PatchStrategy.md b/website/versioned_docs/version-2.0.0/sdk/patch/type-aliases/PatchStrategy.md deleted file mode 100644 index e318f53ca68..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/patch/type-aliases/PatchStrategy.md +++ /dev/null @@ -1,12 +0,0 @@ -# Type Alias: PatchStrategy - -> **PatchStrategy** = *typeof* [`PatchStrategy`](../variables/PatchStrategy.md)\[keyof *typeof* [`PatchStrategy`](../variables/PatchStrategy.md)\] - -Defined in: [src/patch.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/patch.ts#L9) - -Valid Content-Type header values for patch operations. See -https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ -for details. - -Additionally for Server-Side Apply https://kubernetes.io/docs/reference/using-api/server-side-apply/ -and https://kubernetes.io/docs/reference/using-api/server-side-apply/#api-implementation diff --git a/website/versioned_docs/version-2.0.0/sdk/patch/variables/PatchStrategy.md b/website/versioned_docs/version-2.0.0/sdk/patch/variables/PatchStrategy.md deleted file mode 100644 index 778971a3b63..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/patch/variables/PatchStrategy.md +++ /dev/null @@ -1,38 +0,0 @@ -# Variable: PatchStrategy - -> `const` **PatchStrategy**: `object` - -Defined in: [src/patch.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/patch.ts#L9) - -Valid Content-Type header values for patch operations. See -https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ -for details. - -Additionally for Server-Side Apply https://kubernetes.io/docs/reference/using-api/server-side-apply/ -and https://kubernetes.io/docs/reference/using-api/server-side-apply/#api-implementation - -## Type Declaration - -### JsonPatch - -> `readonly` **JsonPatch**: `"application/json-patch+json"` = `'application/json-patch+json'` - -Diff-like JSON format. - -### MergePatch - -> `readonly` **MergePatch**: `"application/merge-patch+json"` = `'application/merge-patch+json'` - -Simple merge. - -### ServerSideApply - -> `readonly` **ServerSideApply**: `"application/apply-patch+yaml"` = `'application/apply-patch+yaml'` - -Server-Side Apply - -### StrategicMergePatch - -> `readonly` **StrategicMergePatch**: `"application/strategic-merge-patch+json"` = `'application/strategic-merge-patch+json'` - -Merge with different strategies depending on field metadata. diff --git a/website/versioned_docs/version-2.0.0/sdk/portforward/classes/PortForward.md b/website/versioned_docs/version-2.0.0/sdk/portforward/classes/PortForward.md deleted file mode 100644 index 8d85ee5a8d1..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/portforward/classes/PortForward.md +++ /dev/null @@ -1,195 +0,0 @@ -# Class: PortForward - -Defined in: [src/portforward.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L9) - -## Constructors - -### Constructor - -> **new PortForward**(`config`, `disconnectOnErr?`, `handler?`): `PortForward` - -Defined in: [src/portforward.ts:15](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L15) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -##### disconnectOnErr? - -`boolean` - -##### handler? - -`WebSocketInterface` - -#### Returns - -`PortForward` - -## Methods - -### portForward() - -> **portForward**(`namespace`, `podName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> - -Defined in: [src/portforward.ts:22](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L22) - -#### Parameters - -##### namespace - -`string` - -##### podName - -`string` - -##### targetPorts - -`number`[] - -##### output - -`Writable` - -##### err - -`Writable` \| `null` - -##### input - -`Readable` - -##### retryCount? - -`number` = `0` - -#### Returns - -`Promise`\<`any`\> - -*** - -### portForwardDeployment() - -> **portForwardDeployment**(`namespace`, `deploymentName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> - -Defined in: [src/portforward.ts:123](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L123) - -Port forward to a deployment by resolving to the first ready pod selected by the deployment's selector. - -#### Parameters - -##### namespace - -`string` - -The namespace of the deployment - -##### deploymentName - -`string` - -The name of the deployment - -##### targetPorts - -`number`[] - -The target ports to forward to - -##### output - -`Writable` - -The writable stream for output - -##### err - -`Writable` \| `null` - -The writable stream for error output (can be null) - -##### input - -`Readable` - -The readable stream for input - -##### retryCount? - -`number` = `0` - -The number of times to retry the connection - -#### Returns - -`Promise`\<`any`\> - -#### Throws - -Will throw an error if the deployment is not found or has no ready pods - -*** - -### portForwardService() - -> **portForwardService**(`namespace`, `serviceName`, `targetPorts`, `output`, `err`, `input`, `retryCount?`): `Promise`\<`any`\> - -Defined in: [src/portforward.ts:89](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/portforward.ts#L89) - -Port forward to a service by resolving to the first ready pod selected by the service's selector. - -#### Parameters - -##### namespace - -`string` - -The namespace of the service - -##### serviceName - -`string` - -The name of the service - -##### targetPorts - -`number`[] - -The target ports to forward to - -##### output - -`Writable` - -The writable stream for output - -##### err - -`Writable` \| `null` - -The writable stream for error output (can be null) - -##### input - -`Readable` - -The readable stream for input - -##### retryCount? - -`number` = `0` - -The number of times to retry the connection - -#### Returns - -`Promise`\<`any`\> - -#### Throws - -Will throw an error if the service is not found or has no ready pods diff --git a/website/versioned_docs/version-2.0.0/sdk/portforward/index.md b/website/versioned_docs/version-2.0.0/sdk/portforward/index.md deleted file mode 100644 index 5330431e384..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/portforward/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# portforward - -## Classes - -- [PortForward](classes/PortForward.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/ContainerStatus.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/ContainerStatus.md deleted file mode 100644 index e3845761a7e..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/top/classes/ContainerStatus.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: ContainerStatus - -Defined in: [src/top.ts:49](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L49) - -## Constructors - -### Constructor - -> **new ContainerStatus**(`Container`, `CPUUsage`, `MemoryUsage`): `ContainerStatus` - -Defined in: [src/top.ts:54](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L54) - -#### Parameters - -##### Container - -`string` - -##### CPUUsage - -[`CurrentResourceUsage`](CurrentResourceUsage.md) - -##### MemoryUsage - -[`CurrentResourceUsage`](CurrentResourceUsage.md) - -#### Returns - -`ContainerStatus` - -## Properties - -### Container - -> `readonly` **Container**: `string` - -Defined in: [src/top.ts:50](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L50) - -*** - -### CPUUsage - -> `readonly` **CPUUsage**: [`CurrentResourceUsage`](CurrentResourceUsage.md) - -Defined in: [src/top.ts:51](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L51) - -*** - -### MemoryUsage - -> `readonly` **MemoryUsage**: [`CurrentResourceUsage`](CurrentResourceUsage.md) - -Defined in: [src/top.ts:52](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L52) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/CurrentResourceUsage.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/CurrentResourceUsage.md deleted file mode 100644 index f358f096dff..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/top/classes/CurrentResourceUsage.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: CurrentResourceUsage - -Defined in: [src/top.ts:25](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L25) - -## Constructors - -### Constructor - -> **new CurrentResourceUsage**(`CurrentUsage`, `RequestTotal`, `LimitTotal`): `CurrentResourceUsage` - -Defined in: [src/top.ts:30](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L30) - -#### Parameters - -##### CurrentUsage - -`number` \| `bigint` - -##### RequestTotal - -`number` \| `bigint` - -##### LimitTotal - -`number` \| `bigint` - -#### Returns - -`CurrentResourceUsage` - -## Properties - -### CurrentUsage - -> `readonly` **CurrentUsage**: `number` \| `bigint` - -Defined in: [src/top.ts:26](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L26) - -*** - -### LimitTotal - -> `readonly` **LimitTotal**: `number` \| `bigint` - -Defined in: [src/top.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L28) - -*** - -### RequestTotal - -> `readonly` **RequestTotal**: `number` \| `bigint` - -Defined in: [src/top.ts:27](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L27) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/NodeStatus.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/NodeStatus.md deleted file mode 100644 index 43537ba4498..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/top/classes/NodeStatus.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: NodeStatus - -Defined in: [src/top.ts:37](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L37) - -## Constructors - -### Constructor - -> **new NodeStatus**(`Node`, `CPU`, `Memory`): `NodeStatus` - -Defined in: [src/top.ts:42](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L42) - -#### Parameters - -##### Node - -`V1Node` - -##### CPU - -[`ResourceUsage`](ResourceUsage.md) - -##### Memory - -[`ResourceUsage`](ResourceUsage.md) - -#### Returns - -`NodeStatus` - -## Properties - -### CPU - -> `readonly` **CPU**: [`ResourceUsage`](ResourceUsage.md) - -Defined in: [src/top.ts:39](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L39) - -*** - -### Memory - -> `readonly` **Memory**: [`ResourceUsage`](ResourceUsage.md) - -Defined in: [src/top.ts:40](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L40) - -*** - -### Node - -> `readonly` **Node**: `V1Node` - -Defined in: [src/top.ts:38](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L38) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/PodStatus.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/PodStatus.md deleted file mode 100644 index 57f06c2f10e..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/top/classes/PodStatus.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: PodStatus - -Defined in: [src/top.ts:61](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L61) - -## Constructors - -### Constructor - -> **new PodStatus**(`Pod`, `CPU`, `Memory`, `Containers`): `PodStatus` - -Defined in: [src/top.ts:67](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L67) - -#### Parameters - -##### Pod - -`V1Pod` - -##### CPU - -[`CurrentResourceUsage`](CurrentResourceUsage.md) - -##### Memory - -[`CurrentResourceUsage`](CurrentResourceUsage.md) - -##### Containers - -[`ContainerStatus`](ContainerStatus.md)[] - -#### Returns - -`PodStatus` - -## Properties - -### Containers - -> `readonly` **Containers**: [`ContainerStatus`](ContainerStatus.md)[] - -Defined in: [src/top.ts:65](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L65) - -*** - -### CPU - -> `readonly` **CPU**: [`CurrentResourceUsage`](CurrentResourceUsage.md) - -Defined in: [src/top.ts:63](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L63) - -*** - -### Memory - -> `readonly` **Memory**: [`CurrentResourceUsage`](CurrentResourceUsage.md) - -Defined in: [src/top.ts:64](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L64) - -*** - -### Pod - -> `readonly` **Pod**: `V1Pod` - -Defined in: [src/top.ts:62](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L62) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/classes/ResourceUsage.md b/website/versioned_docs/version-2.0.0/sdk/top/classes/ResourceUsage.md deleted file mode 100644 index e568265c380..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/top/classes/ResourceUsage.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: ResourceUsage - -Defined in: [src/top.ts:13](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L13) - -## Constructors - -### Constructor - -> **new ResourceUsage**(`Capacity`, `RequestTotal`, `LimitTotal`): `ResourceUsage` - -Defined in: [src/top.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L18) - -#### Parameters - -##### Capacity - -`number` \| `bigint` - -##### RequestTotal - -`number` \| `bigint` - -##### LimitTotal - -`number` \| `bigint` - -#### Returns - -`ResourceUsage` - -## Properties - -### Capacity - -> `readonly` **Capacity**: `number` \| `bigint` - -Defined in: [src/top.ts:14](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L14) - -*** - -### LimitTotal - -> `readonly` **LimitTotal**: `number` \| `bigint` - -Defined in: [src/top.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L16) - -*** - -### RequestTotal - -> `readonly` **RequestTotal**: `number` \| `bigint` - -Defined in: [src/top.ts:15](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L15) diff --git a/website/versioned_docs/version-2.0.0/sdk/top/functions/topNodes.md b/website/versioned_docs/version-2.0.0/sdk/top/functions/topNodes.md deleted file mode 100644 index 9a178e21f85..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/top/functions/topNodes.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: topNodes() - -> **topNodes**(`api`): `Promise`\<[`NodeStatus`](../classes/NodeStatus.md)[]\> - -Defined in: [src/top.ts:80](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L80) - -## Parameters - -### api - -`ObjectCoreV1Api` - -## Returns - -`Promise`\<[`NodeStatus`](../classes/NodeStatus.md)[]\> diff --git a/website/versioned_docs/version-2.0.0/sdk/top/functions/topPods.md b/website/versioned_docs/version-2.0.0/sdk/top/functions/topPods.md deleted file mode 100644 index 786e2c2d443..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/top/functions/topPods.md +++ /dev/null @@ -1,23 +0,0 @@ -# Function: topPods() - -> **topPods**(`api`, `metrics`, `namespace?`): `Promise`\<[`PodStatus`](../classes/PodStatus.md)[]\> - -Defined in: [src/top.ts:111](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/top.ts#L111) - -## Parameters - -### api - -`ObjectCoreV1Api` - -### metrics - -[`Metrics`](../../metrics/classes/Metrics.md) - -### namespace? - -`string` - -## Returns - -`Promise`\<[`PodStatus`](../classes/PodStatus.md)[]\> diff --git a/website/versioned_docs/version-2.0.0/sdk/top/index.md b/website/versioned_docs/version-2.0.0/sdk/top/index.md deleted file mode 100644 index dda791b768b..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/top/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# top - -## Classes - -- [ContainerStatus](classes/ContainerStatus.md) -- [CurrentResourceUsage](classes/CurrentResourceUsage.md) -- [NodeStatus](classes/NodeStatus.md) -- [PodStatus](classes/PodStatus.md) -- [ResourceUsage](classes/ResourceUsage.md) - -## Functions - -- [topNodes](functions/topNodes.md) -- [topPods](functions/topPods.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/typedoc-sidebar.cjs b/website/versioned_docs/version-2.0.0/sdk/typedoc-sidebar.cjs deleted file mode 100644 index 575b5c88e97..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"attach",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/attach/classes/Attach",label:"Attach"}]}],link:{type:"doc",id:"sdk/attach/index"}},{type:"category",label:"cache",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/cache/classes/ListWatch",label:"ListWatch"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/cache/interfaces/ObjectCache",label:"ObjectCache"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/cache/type-aliases/CacheMap",label:"CacheMap"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/cache/functions/addOrUpdateObject",label:"addOrUpdateObject"},{type:"doc",id:"sdk/cache/functions/cacheMapFromList",label:"cacheMapFromList"},{type:"doc",id:"sdk/cache/functions/deleteItems",label:"deleteItems"},{type:"doc",id:"sdk/cache/functions/deleteObject",label:"deleteObject"}]}],link:{type:"doc",id:"sdk/cache/index"}},{type:"category",label:"config",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/config/classes/KubeConfig",label:"KubeConfig"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/config/interfaces/ApiType",label:"ApiType"},{type:"doc",id:"sdk/config/interfaces/Named",label:"Named"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/config/type-aliases/ApiConstructor",label:"ApiConstructor"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/config/functions/bufferFromFileOrString",label:"bufferFromFileOrString"},{type:"doc",id:"sdk/config/functions/findHomeDir",label:"findHomeDir"},{type:"doc",id:"sdk/config/functions/findObject",label:"findObject"},{type:"doc",id:"sdk/config/functions/makeAbsolutePath",label:"makeAbsolutePath"}]}],link:{type:"doc",id:"sdk/config/index"}},{type:"category",label:"config_types",items:[{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/config_types/interfaces/Cluster",label:"Cluster"},{type:"doc",id:"sdk/config_types/interfaces/ConfigOptions",label:"ConfigOptions"},{type:"doc",id:"sdk/config_types/interfaces/Context",label:"Context"},{type:"doc",id:"sdk/config_types/interfaces/User",label:"User"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/config_types/type-aliases/ActionOnInvalid",label:"ActionOnInvalid"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/config_types/variables/ActionOnInvalid",label:"ActionOnInvalid"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/config_types/functions/exportCluster",label:"exportCluster"},{type:"doc",id:"sdk/config_types/functions/exportContext",label:"exportContext"},{type:"doc",id:"sdk/config_types/functions/exportUser",label:"exportUser"},{type:"doc",id:"sdk/config_types/functions/newClusters",label:"newClusters"},{type:"doc",id:"sdk/config_types/functions/newContexts",label:"newContexts"},{type:"doc",id:"sdk/config_types/functions/newUsers",label:"newUsers"}]}],link:{type:"doc",id:"sdk/config_types/index"}},{type:"category",label:"cp",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/cp/classes/Cp",label:"Cp"}]}],link:{type:"doc",id:"sdk/cp/index"}},{type:"category",label:"exec",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/exec/classes/Exec",label:"Exec"}]}],link:{type:"doc",id:"sdk/exec/index"}},{type:"category",label:"health",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/health/classes/Health",label:"Health"}]}],link:{type:"doc",id:"sdk/health/index"}},{type:"category",label:"informer",items:[{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/informer/interfaces/Informer",label:"Informer"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/informer/type-aliases/ADD",label:"ADD"},{type:"doc",id:"sdk/informer/type-aliases/CHANGE",label:"CHANGE"},{type:"doc",id:"sdk/informer/type-aliases/CONNECT",label:"CONNECT"},{type:"doc",id:"sdk/informer/type-aliases/DELETE",label:"DELETE"},{type:"doc",id:"sdk/informer/type-aliases/ERROR",label:"ERROR"},{type:"doc",id:"sdk/informer/type-aliases/ErrorCallback",label:"ErrorCallback"},{type:"doc",id:"sdk/informer/type-aliases/ListCallback",label:"ListCallback"},{type:"doc",id:"sdk/informer/type-aliases/ListPromise",label:"ListPromise"},{type:"doc",id:"sdk/informer/type-aliases/ObjectCallback",label:"ObjectCallback"},{type:"doc",id:"sdk/informer/type-aliases/UPDATE",label:"UPDATE"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/informer/variables/ADD",label:"ADD"},{type:"doc",id:"sdk/informer/variables/CHANGE",label:"CHANGE"},{type:"doc",id:"sdk/informer/variables/CONNECT",label:"CONNECT"},{type:"doc",id:"sdk/informer/variables/DELETE",label:"DELETE"},{type:"doc",id:"sdk/informer/variables/ERROR",label:"ERROR"},{type:"doc",id:"sdk/informer/variables/UPDATE",label:"UPDATE"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/informer/functions/makeInformer",label:"makeInformer"}]}],link:{type:"doc",id:"sdk/informer/index"}},{type:"category",label:"log",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/log/classes/Log",label:"Log"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/log/interfaces/LogOptions",label:"LogOptions"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/log/functions/AddOptionsToSearchParams",label:"AddOptionsToSearchParams"}]}],link:{type:"doc",id:"sdk/log/index"}},{type:"category",label:"metrics",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/metrics/classes/Metrics",label:"Metrics"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/metrics/interfaces/ContainerMetric",label:"ContainerMetric"},{type:"doc",id:"sdk/metrics/interfaces/NodeMetric",label:"NodeMetric"},{type:"doc",id:"sdk/metrics/interfaces/NodeMetricsList",label:"NodeMetricsList"},{type:"doc",id:"sdk/metrics/interfaces/PodMetric",label:"PodMetric"},{type:"doc",id:"sdk/metrics/interfaces/PodMetricsList",label:"PodMetricsList"},{type:"doc",id:"sdk/metrics/interfaces/Usage",label:"Usage"}]}],link:{type:"doc",id:"sdk/metrics/index"}},{type:"category",label:"middleware",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/middleware/functions/setHeaderMiddleware",label:"setHeaderMiddleware"},{type:"doc",id:"sdk/middleware/functions/setHeaderOptions",label:"setHeaderOptions"}]}],link:{type:"doc",id:"sdk/middleware/index"}},{type:"category",label:"object",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/object/classes/KubernetesObjectApi",label:"KubernetesObjectApi"}]}],link:{type:"doc",id:"sdk/object/index"}},{type:"category",label:"patch",items:[{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/patch/type-aliases/PatchStrategy",label:"PatchStrategy"}]},{type:"category",label:"Variables",items:[{type:"doc",id:"sdk/patch/variables/PatchStrategy",label:"PatchStrategy"}]}],link:{type:"doc",id:"sdk/patch/index"}},{type:"category",label:"portforward",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/portforward/classes/PortForward",label:"PortForward"}]}],link:{type:"doc",id:"sdk/portforward/index"}},{type:"category",label:"top",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/top/classes/ContainerStatus",label:"ContainerStatus"},{type:"doc",id:"sdk/top/classes/CurrentResourceUsage",label:"CurrentResourceUsage"},{type:"doc",id:"sdk/top/classes/NodeStatus",label:"NodeStatus"},{type:"doc",id:"sdk/top/classes/PodStatus",label:"PodStatus"},{type:"doc",id:"sdk/top/classes/ResourceUsage",label:"ResourceUsage"}]},{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/top/functions/topNodes",label:"topNodes"},{type:"doc",id:"sdk/top/functions/topPods",label:"topPods"}]}],link:{type:"doc",id:"sdk/top/index"}},{type:"category",label:"types",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/types/classes/V1MicroTime",label:"V1MicroTime"}]},{type:"category",label:"Interfaces",items:[{type:"doc",id:"sdk/types/interfaces/KubernetesListObject",label:"KubernetesListObject"},{type:"doc",id:"sdk/types/interfaces/KubernetesObject",label:"KubernetesObject"}]},{type:"category",label:"Type Aliases",items:[{type:"doc",id:"sdk/types/type-aliases/IntOrString",label:"IntOrString"}]}],link:{type:"doc",id:"sdk/types/index"}},{type:"category",label:"watch",items:[{type:"category",label:"Classes",items:[{type:"doc",id:"sdk/watch/classes/Watch",label:"Watch"}]}],link:{type:"doc",id:"sdk/watch/index"}},{type:"category",label:"yaml",items:[{type:"category",label:"Functions",items:[{type:"doc",id:"sdk/yaml/functions/dumpYaml",label:"dumpYaml"},{type:"doc",id:"sdk/yaml/functions/loadAllYaml",label:"loadAllYaml"},{type:"doc",id:"sdk/yaml/functions/loadYaml",label:"loadYaml"}]}],link:{type:"doc",id:"sdk/yaml/index"}}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/website/versioned_docs/version-2.0.0/sdk/types/classes/V1MicroTime.md b/website/versioned_docs/version-2.0.0/sdk/types/classes/V1MicroTime.md deleted file mode 100644 index c60344e02ec..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/types/classes/V1MicroTime.md +++ /dev/null @@ -1,141 +0,0 @@ -# Class: V1MicroTime - -Defined in: [src/types.ts:18](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L18) - -## Extends - -- `Date` - -## Constructors - -### Constructor - -> **new V1MicroTime**(): `V1MicroTime` - -Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:926 - -#### Returns - -`V1MicroTime` - -#### Inherited from - -`Date.constructor` - -### Constructor - -> **new V1MicroTime**(`value`): `V1MicroTime` - -Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:927 - -#### Parameters - -##### value - -`string` \| `number` - -#### Returns - -`V1MicroTime` - -#### Inherited from - -`Date.constructor` - -### Constructor - -> **new V1MicroTime**(`year`, `monthIndex`, `date?`, `hours?`, `minutes?`, `seconds?`, `ms?`): `V1MicroTime` - -Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:938 - -Creates a new Date. - -#### Parameters - -##### year - -`number` - -The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year. - -##### monthIndex - -`number` - -The month as a number between 0 and 11 (January to December). - -##### date? - -`number` - -The date as a number between 1 and 31. - -##### hours? - -`number` - -Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour. - -##### minutes? - -`number` - -Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes. - -##### seconds? - -`number` - -Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds. - -##### ms? - -`number` - -A number from 0 to 999 that specifies the milliseconds. - -#### Returns - -`V1MicroTime` - -#### Inherited from - -`Date.constructor` - -### Constructor - -> **new V1MicroTime**(`value`): `V1MicroTime` - -Defined in: website/node\_modules/typescript/lib/lib.es5.d.ts:926 - -#### Parameters - -##### value - -`string` \| `number` \| `Date` - -#### Returns - -`V1MicroTime` - -#### Inherited from - -`Date.constructor` - -## Methods - -### toISOString() - -> **toISOString**(): `string` - -Defined in: [src/types.ts:19](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L19) - -Returns a date as a string value in ISO format. - -#### Returns - -`string` - -#### Overrides - -`Date.toISOString` diff --git a/website/versioned_docs/version-2.0.0/sdk/types/index.md b/website/versioned_docs/version-2.0.0/sdk/types/index.md deleted file mode 100644 index cdc701721b3..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/types/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# types - -## Classes - -- [V1MicroTime](classes/V1MicroTime.md) - -## Interfaces - -- [KubernetesListObject](interfaces/KubernetesListObject.md) -- [KubernetesObject](interfaces/KubernetesObject.md) - -## Type Aliases - -- [IntOrString](type-aliases/IntOrString.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesListObject.md b/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesListObject.md deleted file mode 100644 index 64d51265ac2..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesListObject.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: KubernetesListObject\ - -Defined in: [src/types.ts:9](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L9) - -## Type Parameters - -### T - -`T` *extends* [`KubernetesObject`](KubernetesObject.md) - -## Properties - -### apiVersion? - -> `optional` **apiVersion?**: `string` - -Defined in: [src/types.ts:10](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L10) - -*** - -### items - -> **items**: `T`[] - -Defined in: [src/types.ts:13](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L13) - -*** - -### kind? - -> `optional` **kind?**: `string` - -Defined in: [src/types.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L11) - -*** - -### metadata? - -> `optional` **metadata?**: `V1ListMeta` - -Defined in: [src/types.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L12) diff --git a/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesObject.md b/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesObject.md deleted file mode 100644 index 85f27be16f9..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/types/interfaces/KubernetesObject.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: KubernetesObject - -Defined in: [src/types.ts:3](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L3) - -## Properties - -### apiVersion? - -> `optional` **apiVersion?**: `string` - -Defined in: [src/types.ts:4](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L4) - -*** - -### kind? - -> `optional` **kind?**: `string` - -Defined in: [src/types.ts:5](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L5) - -*** - -### metadata? - -> `optional` **metadata?**: `V1ObjectMeta` - -Defined in: [src/types.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L6) diff --git a/website/versioned_docs/version-2.0.0/sdk/types/type-aliases/IntOrString.md b/website/versioned_docs/version-2.0.0/sdk/types/type-aliases/IntOrString.md deleted file mode 100644 index 4ef656418c2..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/types/type-aliases/IntOrString.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: IntOrString - -> **IntOrString** = `number` \| `string` - -Defined in: [src/types.ts:16](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/types.ts#L16) diff --git a/website/versioned_docs/version-2.0.0/sdk/watch/classes/Watch.md b/website/versioned_docs/version-2.0.0/sdk/watch/classes/Watch.md deleted file mode 100644 index 233007bafe2..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/watch/classes/Watch.md +++ /dev/null @@ -1,67 +0,0 @@ -# Class: Watch - -Defined in: [src/watch.ts:6](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L6) - -## Constructors - -### Constructor - -> **new Watch**(`config`): `Watch` - -Defined in: [src/watch.ts:11](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L11) - -#### Parameters - -##### config - -[`KubeConfig`](../../config/classes/KubeConfig.md) - -#### Returns - -`Watch` - -## Properties - -### config - -> **config**: [`KubeConfig`](../../config/classes/KubeConfig.md) - -Defined in: [src/watch.ts:8](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L8) - -*** - -### SERVER\_SIDE\_CLOSE - -> `static` **SERVER\_SIDE\_CLOSE**: `object` - -Defined in: [src/watch.ts:7](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L7) - -## Methods - -### watch() - -> **watch**(`path`, `queryParams`, `callback`, `done`): `Promise`\<`AbortController`\> - -Defined in: [src/watch.ts:21](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/watch.ts#L21) - -#### Parameters - -##### path - -`string` - -##### queryParams - -`Record`\<`string`, `string` \| `number` \| `boolean` \| `undefined`\> - -##### callback - -(`phase`, `apiObj`, `watchObj?`) => `void` - -##### done - -(`err`) => `void` - -#### Returns - -`Promise`\<`AbortController`\> diff --git a/website/versioned_docs/version-2.0.0/sdk/watch/index.md b/website/versioned_docs/version-2.0.0/sdk/watch/index.md deleted file mode 100644 index 6c5ddb17669..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/watch/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# watch - -## Classes - -- [Watch](classes/Watch.md) diff --git a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/dumpYaml.md b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/dumpYaml.md deleted file mode 100644 index ee7fe699f12..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/dumpYaml.md +++ /dev/null @@ -1,27 +0,0 @@ -# Function: dumpYaml() - -> **dumpYaml**(`object`, `opts?`): `string` - -Defined in: [src/yaml.ts:43](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/yaml.ts#L43) - -Dump a Kubernetes object to YAML. - -## Parameters - -### object - -`any` - -The Kubernetes object to dump. - -### opts? - -`any` - -Optional YAML dump options. - -## Returns - -`string` - -The YAML string representation of the serialized Kubernetes object. diff --git a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadAllYaml.md b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadAllYaml.md deleted file mode 100644 index cbd1f2cd088..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadAllYaml.md +++ /dev/null @@ -1,27 +0,0 @@ -# Function: loadAllYaml() - -> **loadAllYaml**(`data`, `opts?`): `any`[] - -Defined in: [src/yaml.ts:28](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/yaml.ts#L28) - -Load all Kubernetes objects from YAML. - -## Parameters - -### data - -`string` - -The YAML string to load. - -### opts? - -`any` - -Optional YAML load options. - -## Returns - -`any`[] - -An array of deserialized Kubernetes objects. diff --git a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadYaml.md b/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadYaml.md deleted file mode 100644 index a8c76574ee9..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/yaml/functions/loadYaml.md +++ /dev/null @@ -1,33 +0,0 @@ -# Function: loadYaml() - -> **loadYaml**\<`T`\>(`data`, `opts?`): `T` - -Defined in: [src/yaml.ts:12](https://github.com/davidgamero/javascript/blob/019ff89c9f584a4d3b0d6eda91fb6ec8395636c9/src/yaml.ts#L12) - -Load a Kubernetes object from YAML. - -## Type Parameters - -### T - -`T` - -## Parameters - -### data - -`string` - -The YAML string to load. - -### opts? - -`any` - -Optional YAML load options. - -## Returns - -`T` - -The deserialized Kubernetes object. diff --git a/website/versioned_docs/version-2.0.0/sdk/yaml/index.md b/website/versioned_docs/version-2.0.0/sdk/yaml/index.md deleted file mode 100644 index 016ec239289..00000000000 --- a/website/versioned_docs/version-2.0.0/sdk/yaml/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# yaml - -## Functions - -- [dumpYaml](functions/dumpYaml.md) -- [loadAllYaml](functions/loadAllYaml.md) -- [loadYaml](functions/loadYaml.md) diff --git a/website/versioned_sidebars/version-2.0.0-sidebars.json b/website/versioned_sidebars/version-2.0.0-sidebars.json deleted file mode 100644 index 28114f3a515..00000000000 --- a/website/versioned_sidebars/version-2.0.0-sidebars.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "docs": [ - { - "type": "category", - "label": "Getting Started", - "collapsed": false, - "items": [ - "intro" - ] - }, - { - "type": "category", - "label": "SDK Reference", - "collapsed": false, - "items": [ - { - "type": "category", - "label": "Configuration", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "sdk/config" - }, - { - "type": "autogenerated", - "dirName": "sdk/config_types" - } - ] - }, - { - "type": "category", - "label": "Watching & Caching", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "sdk/watch" - }, - { - "type": "autogenerated", - "dirName": "sdk/informer" - }, - { - "type": "autogenerated", - "dirName": "sdk/cache" - } - ] - }, - { - "type": "category", - "label": "Pod Operations", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "sdk/exec" - }, - { - "type": "autogenerated", - "dirName": "sdk/attach" - }, - { - "type": "autogenerated", - "dirName": "sdk/portforward" - }, - { - "type": "autogenerated", - "dirName": "sdk/cp" - }, - { - "type": "autogenerated", - "dirName": "sdk/log" - } - ] - }, - { - "type": "category", - "label": "Cluster Operations", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "sdk/metrics" - }, - { - "type": "autogenerated", - "dirName": "sdk/top" - } - ] - }, - { - "type": "category", - "label": "Utilities", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "sdk/object" - }, - { - "type": "autogenerated", - "dirName": "sdk/patch" - }, - { - "type": "autogenerated", - "dirName": "sdk/health" - }, - { - "type": "autogenerated", - "dirName": "sdk/middleware" - }, - { - "type": "autogenerated", - "dirName": "sdk/types" - }, - { - "type": "autogenerated", - "dirName": "sdk/yaml" - } - ] - } - ] - }, - { - "type": "category", - "label": "Kubernetes API Reference", - "collapsed": false, - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "api-reference" - } - ] - } - ] -} diff --git a/website/versions.json b/website/versions.json index 3aea0349a87..fe51488c706 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1,3 +1 @@ -[ - "2.0.0" -] +[] From ca52d028572dd826b101c60cc099519b0ceacba1 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Wed, 24 Jun 2026 14:14:29 -0400 Subject: [PATCH 08/11] docs --- .github/workflows/deploy-docs-v2.yml | 12 +- .github/workflows/release.yml | 12 +- README.md | 10 +- {website => docs}/.gitignore | 0 .../docs/examples/_category_.json | 0 {website => docs}/docs/examples/advanced.mdx | 0 .../docs/examples/basic-operations.mdx | 0 .../docs/examples/kubectl-equivalents.mdx | 0 .../docs/examples/pod-operations.mdx | 0 .../docs/examples/watching-and-caching.mdx | 0 {website => docs}/docs/intro.md | 0 {website => docs}/docusaurus.config.ts | 4 +- {website => docs}/package-lock.json | 0 {website => docs}/package.json | 0 .../fixtures/fixture-expected-issues.md | 0 .../fixtures/fixture-expected-small.md | 0 .../__tests__/fixtures/fixture-small.md | 0 .../__tests__/fixtures/fixture-with-issues.md | 0 .../scripts/__tests__/transform.test.mjs | 0 {website => docs}/scripts/api-group-map.json | 0 {website => docs}/scripts/enrich-sdk-docs.mjs | 0 .../scripts/extract-api-groups.mjs | 0 .../scripts/flatten-sdk-docs.mjs | 11 + {website => docs}/scripts/generate-models.mjs | 199 ++++++++++++++++-- .../scripts/plugin-flatten-sdk.mjs | 0 .../scripts/remark-example-links.mjs | 12 +- .../scripts/transform-gen-docs.mjs | 5 - {website => docs}/sidebars.ts | 0 {website => docs}/src/css/custom.css | 0 {website => docs}/src/pages/404.tsx | 0 {website => docs}/static/.nojekyll | 0 .../static/img/docusaurus-social-card.jpg | Bin {website => docs}/static/img/favicon.ico | Bin {website => docs}/static/img/logo.svg | 0 {website => docs}/tsconfig.docs.json | 0 {website => docs}/tsconfig.json | 0 {website => docs}/versions.json | 0 37 files changed, 219 insertions(+), 46 deletions(-) rename {website => docs}/.gitignore (100%) rename {website => docs}/docs/examples/_category_.json (100%) rename {website => docs}/docs/examples/advanced.mdx (100%) rename {website => docs}/docs/examples/basic-operations.mdx (100%) rename {website => docs}/docs/examples/kubectl-equivalents.mdx (100%) rename {website => docs}/docs/examples/pod-operations.mdx (100%) rename {website => docs}/docs/examples/watching-and-caching.mdx (100%) rename {website => docs}/docs/intro.md (100%) rename {website => docs}/docusaurus.config.ts (98%) rename {website => docs}/package-lock.json (100%) rename {website => docs}/package.json (100%) rename {website => docs}/scripts/__tests__/fixtures/fixture-expected-issues.md (100%) rename {website => docs}/scripts/__tests__/fixtures/fixture-expected-small.md (100%) rename {website => docs}/scripts/__tests__/fixtures/fixture-small.md (100%) rename {website => docs}/scripts/__tests__/fixtures/fixture-with-issues.md (100%) rename {website => docs}/scripts/__tests__/transform.test.mjs (100%) rename {website => docs}/scripts/api-group-map.json (100%) rename {website => docs}/scripts/enrich-sdk-docs.mjs (100%) rename {website => docs}/scripts/extract-api-groups.mjs (100%) rename {website => docs}/scripts/flatten-sdk-docs.mjs (95%) rename {website => docs}/scripts/generate-models.mjs (59%) rename {website => docs}/scripts/plugin-flatten-sdk.mjs (100%) rename {website => docs}/scripts/remark-example-links.mjs (96%) rename {website => docs}/scripts/transform-gen-docs.mjs (99%) rename {website => docs}/sidebars.ts (100%) rename {website => docs}/src/css/custom.css (100%) rename {website => docs}/src/pages/404.tsx (100%) rename {website => docs}/static/.nojekyll (100%) rename {website => docs}/static/img/docusaurus-social-card.jpg (100%) rename {website => docs}/static/img/favicon.ico (100%) rename {website => docs}/static/img/logo.svg (100%) rename {website => docs}/tsconfig.docs.json (100%) rename {website => docs}/tsconfig.json (100%) rename {website => docs}/versions.json (100%) diff --git a/.github/workflows/deploy-docs-v2.yml b/.github/workflows/deploy-docs-v2.yml index b18c4b5d366..29eaaa0aad2 100644 --- a/.github/workflows/deploy-docs-v2.yml +++ b/.github/workflows/deploy-docs-v2.yml @@ -20,17 +20,17 @@ jobs: node-version: '20' - name: Install root dependencies run: npm ci - - name: Install website dependencies + - name: Install docs dependencies run: npm ci - working-directory: website - - name: Build website + working-directory: docs + - name: Build docs run: npm run build - working-directory: website + working-directory: docs - name: Validate links and anchors - run: npx @untitaker/hyperlink website/build --check-anchors --sources website/docs + run: npx @untitaker/hyperlink docs/build --check-anchors --sources docs/docs - name: Deploy to gh-pages if: github.event_name == 'push' uses: JamesIves/github-pages-deploy-action@v4 with: branch: gh-pages - folder: website/build + folder: docs/build diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 7e4a2e3f353..9747ef822df 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -69,17 +69,17 @@ jobs: env: RELEASE_VERSION: ${{ github.event.inputs.releaseVersion }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Install website dependencies - run: cd website && npm ci + - name: Install docs dependencies + run: cd docs && npm ci - name: Run prebuild - run: cd website && npm run prebuild - - name: Create version snapshot - run: cd website && npx docusaurus docs:version ${{ github.event.inputs.releaseVersion }} + run: cd docs && npm run prebuild + - name: Create version snapshot + run: cd docs && npx docusaurus docs:version ${{ github.event.inputs.releaseVersion }} - name: Commit versioned docs if: ${{ github.event.inputs.dry_run != 'true' }} run: | git config user.name "github-actions[bot]" git config user.email "github-actions[bot]@users.noreply.github.com" - git add website/versions.json website/versioned_docs/ website/versioned_sidebars/ + git add docs/versions.json docs/versioned_docs/ docs/versioned_sidebars/ git commit -m "docs: snapshot version ${{ github.ref_name }}" || echo "No changes to commit" git push diff --git a/README.md b/README.md index 160ef6ea0d7..dbdf747d994 100644 --- a/README.md +++ b/README.md @@ -112,23 +112,23 @@ Documentation is built with [Docusaurus](https://docusaurus.io/) and includes: # From the repo root — install the client library (needed by typedoc) npm install -# Install website dependencies and start the dev server -cd website +# Install docs dependencies and start the dev server +cd docs npm install npm start # opens http://localhost:3000 with hot-reload ``` `npm start` automatically runs the `prestart` hook which generates the API reference, SDK docs, and model pages from source before launching the dev -server. Changes to hand-written docs (e.g. `website/docs/examples/`) are +server. Changes to hand-written docs (e.g. `docs/docs/examples/`) are reflected instantly; changes to the generated sources require restarting the server. To do a full production build (which also validates all links): ```bash -cd website -npm run build # generates + builds static site into website/build/ +cd docs +npm run build # generates + builds static site into docs/build/ npm run serve # preview the production build at http://localhost:3000 ``` diff --git a/website/.gitignore b/docs/.gitignore similarity index 100% rename from website/.gitignore rename to docs/.gitignore diff --git a/website/docs/examples/_category_.json b/docs/docs/examples/_category_.json similarity index 100% rename from website/docs/examples/_category_.json rename to docs/docs/examples/_category_.json diff --git a/website/docs/examples/advanced.mdx b/docs/docs/examples/advanced.mdx similarity index 100% rename from website/docs/examples/advanced.mdx rename to docs/docs/examples/advanced.mdx diff --git a/website/docs/examples/basic-operations.mdx b/docs/docs/examples/basic-operations.mdx similarity index 100% rename from website/docs/examples/basic-operations.mdx rename to docs/docs/examples/basic-operations.mdx diff --git a/website/docs/examples/kubectl-equivalents.mdx b/docs/docs/examples/kubectl-equivalents.mdx similarity index 100% rename from website/docs/examples/kubectl-equivalents.mdx rename to docs/docs/examples/kubectl-equivalents.mdx diff --git a/website/docs/examples/pod-operations.mdx b/docs/docs/examples/pod-operations.mdx similarity index 100% rename from website/docs/examples/pod-operations.mdx rename to docs/docs/examples/pod-operations.mdx diff --git a/website/docs/examples/watching-and-caching.mdx b/docs/docs/examples/watching-and-caching.mdx similarity index 100% rename from website/docs/examples/watching-and-caching.mdx rename to docs/docs/examples/watching-and-caching.mdx diff --git a/website/docs/intro.md b/docs/docs/intro.md similarity index 100% rename from website/docs/intro.md rename to docs/docs/intro.md diff --git a/website/docusaurus.config.ts b/docs/docusaurus.config.ts similarity index 98% rename from website/docusaurus.config.ts rename to docs/docusaurus.config.ts index 9d52f121f76..c49b1d725a3 100644 --- a/website/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -38,7 +38,7 @@ const config: Config = { docs: { routeBasePath: '/', sidebarPath: './sidebars.ts', - editUrl: 'https://github.com/kubernetes-client/javascript/tree/main/website/', + editUrl: 'https://github.com/kubernetes-client/javascript/tree/main/docs/', remarkPlugins: [remarkExampleLinks], }, blog: false, @@ -77,7 +77,7 @@ const config: Config = { entryPointStrategy: 'expand', tsconfig: './tsconfig.docs.json', out: 'docs/sdk', - sidebar: { autoConfiguration: true }, + sidebar: { autoConfiguration: false }, readme: 'none', excludeExternals: true, excludePrivate: true, diff --git a/website/package-lock.json b/docs/package-lock.json similarity index 100% rename from website/package-lock.json rename to docs/package-lock.json diff --git a/website/package.json b/docs/package.json similarity index 100% rename from website/package.json rename to docs/package.json diff --git a/website/scripts/__tests__/fixtures/fixture-expected-issues.md b/docs/scripts/__tests__/fixtures/fixture-expected-issues.md similarity index 100% rename from website/scripts/__tests__/fixtures/fixture-expected-issues.md rename to docs/scripts/__tests__/fixtures/fixture-expected-issues.md diff --git a/website/scripts/__tests__/fixtures/fixture-expected-small.md b/docs/scripts/__tests__/fixtures/fixture-expected-small.md similarity index 100% rename from website/scripts/__tests__/fixtures/fixture-expected-small.md rename to docs/scripts/__tests__/fixtures/fixture-expected-small.md diff --git a/website/scripts/__tests__/fixtures/fixture-small.md b/docs/scripts/__tests__/fixtures/fixture-small.md similarity index 100% rename from website/scripts/__tests__/fixtures/fixture-small.md rename to docs/scripts/__tests__/fixtures/fixture-small.md diff --git a/website/scripts/__tests__/fixtures/fixture-with-issues.md b/docs/scripts/__tests__/fixtures/fixture-with-issues.md similarity index 100% rename from website/scripts/__tests__/fixtures/fixture-with-issues.md rename to docs/scripts/__tests__/fixtures/fixture-with-issues.md diff --git a/website/scripts/__tests__/transform.test.mjs b/docs/scripts/__tests__/transform.test.mjs similarity index 100% rename from website/scripts/__tests__/transform.test.mjs rename to docs/scripts/__tests__/transform.test.mjs diff --git a/website/scripts/api-group-map.json b/docs/scripts/api-group-map.json similarity index 100% rename from website/scripts/api-group-map.json rename to docs/scripts/api-group-map.json diff --git a/website/scripts/enrich-sdk-docs.mjs b/docs/scripts/enrich-sdk-docs.mjs similarity index 100% rename from website/scripts/enrich-sdk-docs.mjs rename to docs/scripts/enrich-sdk-docs.mjs diff --git a/website/scripts/extract-api-groups.mjs b/docs/scripts/extract-api-groups.mjs similarity index 100% rename from website/scripts/extract-api-groups.mjs rename to docs/scripts/extract-api-groups.mjs diff --git a/website/scripts/flatten-sdk-docs.mjs b/docs/scripts/flatten-sdk-docs.mjs similarity index 95% rename from website/scripts/flatten-sdk-docs.mjs rename to docs/scripts/flatten-sdk-docs.mjs index 0c0ce47b99a..8b3ac533217 100644 --- a/website/scripts/flatten-sdk-docs.mjs +++ b/docs/scripts/flatten-sdk-docs.mjs @@ -142,6 +142,17 @@ function flattenSmallModule(moduleDir, moduleName, contentFiles) { return match.slice(3); }); + // If the doc basename matches the module name (case-insensitive), + // Docusaurus will generate a route that collides with index.md. + // Add explicit slug frontmatter to disambiguate. + const docBaseName = destName.replace(/\.md$/, ''); + if (docBaseName.toLowerCase() === moduleName.toLowerCase()) { + const slugLine = `---\nslug: ${docBaseName}-class\n---\n\n`; + if (!content.startsWith('---')) { + content = slugLine + content; + } + } + writeFileSync(dest, content, 'utf8'); movedFiles.push({ fileName: destName, fromSub: sub, original: file }); } diff --git a/website/scripts/generate-models.mjs b/docs/scripts/generate-models.mjs similarity index 59% rename from website/scripts/generate-models.mjs rename to docs/scripts/generate-models.mjs index 0fde413cc1b..7e2ae9c6525 100644 --- a/website/scripts/generate-models.mjs +++ b/docs/scripts/generate-models.mjs @@ -41,6 +41,29 @@ function collectReferencedTypes() { } walkDir(API_DOCS_DIR); + + // Expand with transitive references: types referenced by model properties + let frontier = [...types]; + while (frontier.length > 0) { + const next = []; + for (const typeName of frontier) { + const tsFile = join(MODELS_DIR, `${typeName}.ts`); + if (!existsSync(tsFile)) continue; + const content = readFileSync(tsFile, 'utf8'); + for (const match of content.matchAll(pattern)) { + const name = match[0]; + if (!name.endsWith('Api') && !types.has(name)) { + const file = join(MODELS_DIR, `${name}.ts`); + if (existsSync(file)) { + types.add(name); + next.push(name); + } + } + } + } + frontier = next; + } + return [...types].sort(); } @@ -101,13 +124,28 @@ function formatType(typeStr) { .replace(/\{ \[key: string\]: string; \}/g, 'Record'); } -function typeLink(typeStr) { +/** + * Build a lookup from type name -> page slug for cross-page linking. + * Set externally by generateModels() after grouping is computed. + */ +let _typePage = new Map(); +function setTypePageMap(map) { _typePage = map; } + +function typeLink(typeStr, currentSlug) { return typeStr.replace( /\b(V\d(?:alpha\d|beta\d)?[A-Z]\w+)\b/g, (m) => { const tsFile = join(MODELS_DIR, `${m}.ts`); - if (existsSync(tsFile)) return `[${m}](#${m.toLowerCase()})`; - return m; + if (!existsSync(tsFile)) return m; + const targetSlug = _typePage.get(m); + if (!targetSlug) { + // Type exists but isn't included in generated pages — link to source + return `[${m}](${GITHUB_BASE}/${m}.ts)`; + } + if (targetSlug === currentSlug) { + return `[${m}](#${m.toLowerCase()})`; + } + return `[${m}](/models/${targetSlug}#${m.toLowerCase()})`; } ); } @@ -130,7 +168,7 @@ function groupType(typeName) { /** * Scan API reference docs to find which methods use each model type - * (as body param or return type). Returns a Map of typeName -> [{ method, page }]. + * (as body param or return type). Returns a Map of typeName -> [{ method, page, apiClass, isBody }]. */ function collectModelUsage() { const usage = new Map(); @@ -143,11 +181,12 @@ function collectModelUsage() { walkDir(full); } else if (entry.name.endsWith('.md')) { const content = readFileSync(full, 'utf8'); - // Find method headings and their associated types const lines = content.split('\n'); let currentMethod = null; - // Derive the page path from the file path const relPath = full.replace(/.*\/docs\//, '/').replace(/\.md$/, '').replace(/\/index$/, ''); + // Derive API class name: if file is in a subdirectory named like an API class, use that + const parentDir = full.split('/').slice(-2, -1)[0]; + const apiClass = /Api$/.test(parentDir) ? parentDir : entry.name.replace(/\.md$/, ''); for (const line of lines) { const methodMatch = line.match(/^#{2,3}\s+([a-z]\w+)\s*$/); if (methodMatch) { @@ -155,21 +194,19 @@ function collectModelUsage() { continue; } if (!currentMethod) continue; - // Look for model types in signature, param table, and return type lines if (line.includes('V1') || line.includes('V2')) { + const isBody = /\*\*body\*\*/.test(line) || /^\s*>\s.*\(body\)/.test(line); for (const m of line.matchAll(pattern)) { const typeName = m[0]; if (typeName.endsWith('Api') || typeName.endsWith('Request')) continue; if (!usage.has(typeName)) usage.set(typeName, []); const refs = usage.get(typeName); - const ref = { method: currentMethod, page: relPath }; - // Deduplicate + const ref = { method: currentMethod, page: relPath, apiClass, isBody }; if (!refs.some(r => r.method === ref.method && r.page === ref.page)) { refs.push(ref); } } } - // Reset on next heading if (line.match(/^#{2,3}\s/)) currentMethod = null; } } @@ -180,6 +217,102 @@ function collectModelUsage() { return usage; } +/** + * Generate a TypeScript example snippet for a model type. + * - For models used as body params (create/patch): show constructing and passing to API + * - For list models: show iterating over items + * - For other models: show accessing properties from a response + */ +function generateExample(model, modelUsage) { + const refs = modelUsage?.get(model.typeName); + const typeName = model.typeName; + const props = model.properties; + + // Skip models with no properties or very internal types + if (props.length === 0) return null; + if (/^V\d+(Status|Condition|StatusDetails|StatusCause)$/.test(typeName)) return null; + + // Find a create/replace/patch method that uses this type (likely as body) + const bodyRef = refs?.find(r => /^(create|replace|patch)/.test(r.method)); + + // List types — show iteration + if (typeName.endsWith('List') && props.some(p => p.name === 'items')) { + const itemType = typeName.replace(/List$/, ''); + const readRef = refs?.find(r => /^list/.test(r.method)); + const apiClass = readRef?.apiClass || 'CoreV1Api'; + const method = readRef?.method || 'listNamespacedPod'; + return [ + `import * as k8s from '@kubernetes/client-node';`, + ``, + `const kc = new k8s.KubeConfig();`, + `kc.loadFromDefault();`, + `const api = kc.makeApiClient(k8s.${apiClass});`, + ``, + `const res: k8s.${typeName} = await api.${method}({ namespace: 'default' });`, + `for (const item of res.items) {`, + ` console.log(item.metadata?.name);`, + `}`, + ].join('\n'); + } + + // Body param types — show constructing and sending + if (bodyRef) { + const apiClass = bodyRef.apiClass; + const method = bodyRef.method; + const exampleProps = []; + + // Always include metadata with name if the model has it + if (props.some(p => p.name === 'metadata')) { + exampleProps.push(` metadata: { name: 'example' },`); + } + // Include 'spec' stub if present + if (props.some(p => p.name === 'spec')) { + exampleProps.push(` spec: { /* ... */ },`); + } + + const needsNamespace = method.includes('Namespaced'); + const callArgs = needsNamespace + ? `{ namespace: 'default', body }` + : `{ body }`; + + return [ + `import * as k8s from '@kubernetes/client-node';`, + ``, + `const kc = new k8s.KubeConfig();`, + `kc.loadFromDefault();`, + `const api = kc.makeApiClient(k8s.${apiClass});`, + ``, + `const body: k8s.${typeName} = {`, + ...exampleProps, + `};`, + `const res = await api.${method}(${callArgs});`, + `console.log(res.metadata?.name);`, + ].join('\n'); + } + + // Read-only / response types — show accessing from a response + const readRef = refs?.find(r => /^(read|get|list)/.test(r.method)); + if (readRef) { + const apiClass = readRef.apiClass; + const method = readRef.method; + const sampleProp = props.find(p => !['apiVersion', 'kind', 'metadata'].includes(p.name)) + || props[0]; + + return [ + `import * as k8s from '@kubernetes/client-node';`, + ``, + `const kc = new k8s.KubeConfig();`, + `kc.loadFromDefault();`, + `const api = kc.makeApiClient(k8s.${apiClass});`, + ``, + `const res: k8s.${typeName} = await api.${method}(/* ... */);`, + `console.log(res.${sampleProp.name});`, + ].join('\n'); + } + + return null; +} + function generateModelPage(group, models, modelUsage) { const slug = group.toLowerCase().replace(/[^a-z0-9]+/g, '-'); const lines = [ @@ -208,15 +341,27 @@ function generateModelPage(group, models, modelUsage) { lines.push('| Property | Type | Description |'); lines.push('|----------|------|-------------|'); for (const prop of model.properties) { - const type = typeLink(formatType(prop.type)); + const type = typeLink(formatType(prop.type), slug); const doc = prop.doc.length > 200 ? prop.doc.slice(0, 200).replace(/\s\S*$/, '') + '...' : prop.doc; - lines.push(`| \`${prop.name}\` | \`${type}\` | ${doc} |`); + const typeCell = type.includes('](') ? type : `\`${type}\``; + lines.push(`| \`${prop.name}\` | ${typeCell} | ${doc} |`); } lines.push(''); } + // Add example code snippet + const example = generateExample(model, modelUsage); + if (example) { + lines.push('**Example**'); + lines.push(''); + lines.push('```typescript'); + lines.push(example); + lines.push('```'); + lines.push(''); + } + // Add "Used by" reverse links to API methods const refs = modelUsage?.get(model.typeName); if (refs && refs.length > 0) { @@ -228,17 +373,24 @@ function generateModelPage(group, models, modelUsage) { } const links = []; for (const [page, methods] of byPage) { - const label = page.split('/').pop(); - const methodAnchors = methods.slice(0, 3).map(m => `[\`${m}\`](${page}#${m})`); + // Extract API class: find the segment ending in 'Api' in the path + const segments = page.split('/'); + const apiName = segments.find(s => /Api$/.test(s)) || segments.pop(); + const methodAnchors = methods.slice(0, 3).map(m => ({ + label: `${apiName}.${m}`, + md: `[\`${apiName}.${m}\`](${page}#${m})`, + })); links.push(...methodAnchors); } - if (links.length > 0) { + links.sort((a, b) => a.label.localeCompare(b.label)); + const linksMd = links.map(l => l.md); + if (linksMd.length > 0) { const INLINE_LIMIT = 20; - if (links.length <= INLINE_LIMIT) { - lines.push(`**Used by:** ${links.join(' · ')}`); + if (linksMd.length <= INLINE_LIMIT) { + lines.push(`**Used by:** ${linksMd.join(' · ')}`); } else { - const shown = links.slice(0, INLINE_LIMIT); - const rest = links.slice(INLINE_LIMIT); + const shown = linksMd.slice(0, INLINE_LIMIT); + const rest = linksMd.slice(INLINE_LIMIT); lines.push(`**Used by:** ${shown.join(' · ')}`); lines.push(''); lines.push(`
and ${rest.length} more…`); @@ -269,6 +421,15 @@ export function generateModels() { groups.get(group).push(model); } + // Build type -> page slug map before generating pages + const pageMap = new Map(); + for (const model of models) { + const group = groupType(model.typeName); + const slug = group.toLowerCase().replace(/[^a-z0-9]+/g, '-'); + pageMap.set(model.typeName, slug); + } + setTypePageMap(pageMap); + mkdirSync(OUTPUT_DIR, { recursive: true }); const groupOrder = ['Core', 'Workloads', 'Networking', 'Security', 'Configuration & Storage', 'Cluster', 'Other']; diff --git a/website/scripts/plugin-flatten-sdk.mjs b/docs/scripts/plugin-flatten-sdk.mjs similarity index 100% rename from website/scripts/plugin-flatten-sdk.mjs rename to docs/scripts/plugin-flatten-sdk.mjs diff --git a/website/scripts/remark-example-links.mjs b/docs/scripts/remark-example-links.mjs similarity index 96% rename from website/scripts/remark-example-links.mjs rename to docs/scripts/remark-example-links.mjs index 7d5c801a6da..aa2c193335f 100644 --- a/website/scripts/remark-example-links.mjs +++ b/docs/scripts/remark-example-links.mjs @@ -160,8 +160,8 @@ function detectLinks(source) { * Large modules (config, config_types, informer, cache, metrics, top) keep * their original structure. */ - const MERGED_MODULES = new Set(['attach', 'cp', 'exec', 'health', 'log', 'object', 'portforward', 'watch']); - const FLATTENED_MODULES = new Set(['middleware', 'patch', 'types', 'yaml']); + const MERGED_MODULES = new Set(['attach', 'cp', 'exec', 'health', 'object', 'portforward', 'watch']); + const FLATTENED_MODULES = new Set(['log', 'middleware', 'patch', 'types', 'yaml']); function resolveDocPath(docPath) { const parts = docPath.split('/'); @@ -177,7 +177,13 @@ function detectLinks(source) { } if (FLATTENED_MODULES.has(moduleName)) { // Small module: sub-dirs removed, files at module root - return `${parts.slice(0, 3).join('/')}/${fileName}`; + // If filename matches module name (case-insensitive), it gets a -class slug + // to avoid route collision with index.md + let resolved = `${parts.slice(0, 3).join('/')}/${fileName}`; + if (fileName.toLowerCase() === moduleName.toLowerCase()) { + resolved += '-class'; + } + return resolved; } // Large module: keep original path return docPath; diff --git a/website/scripts/transform-gen-docs.mjs b/docs/scripts/transform-gen-docs.mjs similarity index 99% rename from website/scripts/transform-gen-docs.mjs rename to docs/scripts/transform-gen-docs.mjs index f9794efd2fb..0aed56c6691 100644 --- a/website/scripts/transform-gen-docs.mjs +++ b/docs/scripts/transform-gen-docs.mjs @@ -895,11 +895,6 @@ function cleanupContent(content) { return `**[${typeName}](/models/${page}#${typeName.toLowerCase()})**`; }, ); - // Also link types in parameter table body column: **body** | **V1Pod** | ... - result = result.replace( - /\*\*(V\d(?:alpha\d|beta\d)?[A-Z]\w+)\*\*/g, - (full, typeName) => `**[${typeName}](${K8S_SOURCE_BASE}/${typeName}.ts)**`, - ); // Unbold model names in return signatures and return type sections result = result.replace(/^>\s+\*\*([^*]+)\*\*(\s+.+)$/gm, '> $1$2'); diff --git a/website/sidebars.ts b/docs/sidebars.ts similarity index 100% rename from website/sidebars.ts rename to docs/sidebars.ts diff --git a/website/src/css/custom.css b/docs/src/css/custom.css similarity index 100% rename from website/src/css/custom.css rename to docs/src/css/custom.css diff --git a/website/src/pages/404.tsx b/docs/src/pages/404.tsx similarity index 100% rename from website/src/pages/404.tsx rename to docs/src/pages/404.tsx diff --git a/website/static/.nojekyll b/docs/static/.nojekyll similarity index 100% rename from website/static/.nojekyll rename to docs/static/.nojekyll diff --git a/website/static/img/docusaurus-social-card.jpg b/docs/static/img/docusaurus-social-card.jpg similarity index 100% rename from website/static/img/docusaurus-social-card.jpg rename to docs/static/img/docusaurus-social-card.jpg diff --git a/website/static/img/favicon.ico b/docs/static/img/favicon.ico similarity index 100% rename from website/static/img/favicon.ico rename to docs/static/img/favicon.ico diff --git a/website/static/img/logo.svg b/docs/static/img/logo.svg similarity index 100% rename from website/static/img/logo.svg rename to docs/static/img/logo.svg diff --git a/website/tsconfig.docs.json b/docs/tsconfig.docs.json similarity index 100% rename from website/tsconfig.docs.json rename to docs/tsconfig.docs.json diff --git a/website/tsconfig.json b/docs/tsconfig.json similarity index 100% rename from website/tsconfig.json rename to docs/tsconfig.json diff --git a/website/versions.json b/docs/versions.json similarity index 100% rename from website/versions.json rename to docs/versions.json From 5e67e90274340696dc220b3829324ec8ec4b95b6 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Wed, 24 Jun 2026 15:03:50 -0400 Subject: [PATCH 09/11] docs: mark docs/package-lock.json as generated Collapses the lockfile in PR diffs and excludes it from GitHub language statistics, so the ~4.4k of reviewable changes aren't buried under the ~19k-line generated lockfile. --- .gitattributes | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000000..56a84251154 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto-generated lockfile; collapse in diffs and exclude from language stats +docs/package-lock.json linguist-generated=true From 79dfd4c7463b8991f8ee20cc7ede032cce68e8e1 Mon Sep 17 00:00:00 2001 From: David Gamero Date: Wed, 24 Jun 2026 16:36:09 -0400 Subject: [PATCH 10/11] fix(docs): index search from site root so search works Docs are served at routeBasePath '/', but @easyops-cn/docusaurus-search-local defaults docsRouteBasePath to '/docs'. The mismatch meant zero documents were indexed and no search-index.json was emitted, so the search box spun forever. Set docsRouteBasePath: '/' to match. Verified the index now contains real terms (KubeConfig, Watch, Pod, Informer). --- docs/docusaurus.config.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index c49b1d725a3..22f124c2b1d 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -95,6 +95,11 @@ const config: Config = { hashed: true, language: ['en'], indexDocs: true, + // Docs are served at the site root (docs.routeBasePath: '/'), + // so the search indexer must scan from '/' too. The plugin + // defaults to '/docs', which would index zero documents and + // leave the search box spinning forever. + docsRouteBasePath: '/', indexBlog: false, indexPages: false, highlightSearchTermsOnTargetPage: true, From d188158acd11f87aac31f8706d2ca9de560eceba Mon Sep 17 00:00:00 2001 From: David Gamero Date: Thu, 25 Jun 2026 14:55:09 -0400 Subject: [PATCH 11/11] ci: pin GitHub Actions to SHAs in deploy-docs-v2 workflow Per k8s policy, action refs must be pinned to full-length commit SHAs rather than version tags. Pins checkout, setup-node, and the gh-pages deploy action to the same SHAs already used by the sibling workflows. --- .github/workflows/deploy-docs-v2.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deploy-docs-v2.yml b/.github/workflows/deploy-docs-v2.yml index 29eaaa0aad2..5c6bfc93c5b 100644 --- a/.github/workflows/deploy-docs-v2.yml +++ b/.github/workflows/deploy-docs-v2.yml @@ -13,9 +13,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v6.0.1 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - name: Setup Node.js - uses: actions/setup-node@v6 + uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 with: node-version: '20' - name: Install root dependencies @@ -30,7 +30,7 @@ jobs: run: npx @untitaker/hyperlink docs/build --check-anchors --sources docs/docs - name: Deploy to gh-pages if: github.event_name == 'push' - uses: JamesIves/github-pages-deploy-action@v4 + uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0 with: branch: gh-pages folder: docs/build